diff --git a/core/src/components/footer/readme.md b/core/src/components/footer/readme.md index 975b404fc9..3dfd7b1d81 100644 --- a/core/src/components/footer/readme.md +++ b/core/src/components/footer/readme.md @@ -16,6 +16,16 @@ The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. +#### translucent + +boolean + +If true, the footer will be translucent. +Note: In order to scroll content behind the footer, the `fullscreen` +attribute needs to be set on the content. +Defaults to `false`. + + ## Attributes #### mode @@ -26,6 +36,16 @@ The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. +#### translucent + +boolean + +If true, the footer will be translucent. +Note: In order to scroll content behind the footer, the `fullscreen` +attribute needs to be set on the content. +Defaults to `false`. + + ---------------------------------------------- diff --git a/core/src/components/header/readme.md b/core/src/components/header/readme.md index 92d68f78cd..d4632484c1 100644 --- a/core/src/components/header/readme.md +++ b/core/src/components/header/readme.md @@ -18,6 +18,16 @@ The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. +#### translucent + +boolean + +If true, the header will be translucent. +Note: In order to scroll content behind the header, the `fullscreen` +attribute needs to be set on the content. +Defaults to `false`. + + ## Attributes #### mode @@ -28,6 +38,16 @@ The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. +#### translucent + +boolean + +If true, the header will be translucent. +Note: In order to scroll content behind the header, the `fullscreen` +attribute needs to be set on the content. +Defaults to `false`. + + ---------------------------------------------- diff --git a/core/src/components/item/readme.md b/core/src/components/item/readme.md index 00aaa6a798..f7f19c0fea 100644 --- a/core/src/components/item/readme.md +++ b/core/src/components/item/readme.md @@ -117,6 +117,15 @@ another page using `href`. string +#### type + +string + +The type of the button. Only used when an `onclick` or `button` property is present. +Possible values are: `"submit"`, `"reset"` and `"button"`. +Default value is: `"button"` + + ## Attributes #### button @@ -191,6 +200,15 @@ another page using `href`. string +#### type + +string + +The type of the button. Only used when an `onclick` or `button` property is present. +Possible values are: `"submit"`, `"reset"` and `"button"`. +Default value is: `"button"` + + ---------------------------------------------- diff --git a/core/src/components/list/readme.md b/core/src/components/list/readme.md index e0bb15beb2..55db206252 100644 --- a/core/src/components/list/readme.md +++ b/core/src/components/list/readme.md @@ -15,7 +15,7 @@ Lists support several interactions including swiping items to reveal options, dr boolean -If true, the list will have margin around it and rounded corners. Defaults to `"false"`. +If true, the list will have margin around it and rounded corners. Defaults to `false`. #### lines @@ -31,7 +31,7 @@ How the bottom border should be displayed on all items. boolean -If true, the list will have margin around it and rounded corners. Defaults to `"false"`. +If true, the list will have margin around it and rounded corners. Defaults to `false`. #### lines diff --git a/core/src/components/tab-button/readme.md b/core/src/components/tab-button/readme.md index 81a63bc758..77406bcc65 100644 --- a/core/src/components/tab-button/readme.md +++ b/core/src/components/tab-button/readme.md @@ -22,7 +22,7 @@ string boolean -If the tab is selected or not +If true, the tab button will be selected. Defaults to `false`. #### tab @@ -48,7 +48,7 @@ string boolean -If the tab is selected or not +If true, the tab button will be selected. Defaults to `false`. #### tab diff --git a/core/src/components/tab/readme.md b/core/src/components/tab/readme.md index 4e66af3712..ccea35f366 100644 --- a/core/src/components/tab/readme.md +++ b/core/src/components/tab/readme.md @@ -16,7 +16,7 @@ See the [Tabs API Docs](../Tabs/) for more details on configuring Tabs. boolean -If the tab is active or not +If true, sets the tab as the active tab. #### badge @@ -51,6 +51,8 @@ The component to display inside of the tab. FrameworkDelegate +hidden + #### disabled @@ -77,7 +79,7 @@ The icon for the tab. string -The title of the tab. +The label of the tab. #### name @@ -114,7 +116,7 @@ If true, hide the tabs on child pages. boolean -If the tab is active or not +If true, sets the tab as the active tab. #### badge @@ -149,6 +151,8 @@ The component to display inside of the tab. +hidden + #### disabled @@ -175,7 +179,7 @@ The icon for the tab. string -The title of the tab. +The label of the tab. #### name diff --git a/core/src/components/tabbar/readme.md b/core/src/components/tabbar/readme.md index 4437abd835..c8ba1829c1 100644 --- a/core/src/components/tabbar/readme.md +++ b/core/src/components/tabbar/readme.md @@ -17,14 +17,14 @@ string boolean -If the tabbar should include the highlight on the active tab +If true, show the tab highlight bar under the selected tab. #### layout string -The layout of the title and icons +Set the layout of the text and icon in the tabbar. Available options: `"icon-top"`, `"icon-start"`, `"icon-end"`, `"icon-bottom"`, `"icon-hide"`, `"label-hide"`. #### mode @@ -36,14 +36,14 @@ string string -The placement of the tabbar in the app +Set the position of the tabbar, relative to the content. Available options: `"top"`, `"bottom"`. #### scrollable boolean -If the tabbar is scrollable or not +If true, the tabs will be scrollable when there are enough tabs to overflow the width of the screen. #### selectedTab @@ -78,14 +78,14 @@ string boolean -If the tabbar should include the highlight on the active tab +If true, show the tab highlight bar under the selected tab. #### layout string -The layout of the title and icons +Set the layout of the text and icon in the tabbar. Available options: `"icon-top"`, `"icon-start"`, `"icon-end"`, `"icon-bottom"`, `"icon-hide"`, `"label-hide"`. #### mode @@ -97,14 +97,14 @@ string string -The placement of the tabbar in the app +Set the position of the tabbar, relative to the content. Available options: `"top"`, `"bottom"`. #### scrollable boolean -If the tabbar is scrollable or not +If true, the tabs will be scrollable when there are enough tabs to overflow the width of the screen. #### selected-tab diff --git a/core/src/components/tabs/readme.md b/core/src/components/tabs/readme.md index e785d6f28e..e9c1a542cc 100644 --- a/core/src/components/tabs/readme.md +++ b/core/src/components/tabs/readme.md @@ -21,21 +21,21 @@ Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"wa string -A unique name for the tabs +A unique name for the tabs. #### scrollable boolean -If the tabs should be scrollable +If true, the tabs will be scrollable when there are enough tabs to overflow the width of the screen. #### tabbarHidden boolean -If true, the tabbar +If true, the tabbar will be hidden. Defaults to `false`. #### tabbarHighlight @@ -49,14 +49,14 @@ If true, show the tab highlight bar under the selected tab. string -Set the tabbar layout: `icon-top`, `icon-start`, `icon-end`, `icon-bottom`, `icon-hide`, `title-hide`. +Set the layout of the text and icon in the tabbar. Available options: `"icon-top"`, `"icon-start"`, `"icon-end"`, `"icon-bottom"`, `"icon-hide"`, `"label-hide"`. #### tabbarPlacement string -Set position of the tabbar: `top`, `bottom`. +Set the position of the tabbar, relative to the content. Available options: `"top"`, `"bottom"`. #### translucent @@ -73,8 +73,7 @@ Defaults to `false`. boolean -If the tabs should use the router or not. -If true, `selectedTab` does nothing. +If true, the tabs will use the router and `selectedTab` will not do anything. ## Attributes @@ -91,21 +90,21 @@ Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"wa string -A unique name for the tabs +A unique name for the tabs. #### scrollable boolean -If the tabs should be scrollable +If true, the tabs will be scrollable when there are enough tabs to overflow the width of the screen. #### tabbar-hidden boolean -If true, the tabbar +If true, the tabbar will be hidden. Defaults to `false`. #### tabbar-highlight @@ -119,14 +118,14 @@ If true, show the tab highlight bar under the selected tab. string -Set the tabbar layout: `icon-top`, `icon-start`, `icon-end`, `icon-bottom`, `icon-hide`, `title-hide`. +Set the layout of the text and icon in the tabbar. Available options: `"icon-top"`, `"icon-start"`, `"icon-end"`, `"icon-bottom"`, `"icon-hide"`, `"label-hide"`. #### tabbar-placement string -Set position of the tabbar: `top`, `bottom`. +Set the position of the tabbar, relative to the content. Available options: `"top"`, `"bottom"`. #### translucent @@ -143,8 +142,7 @@ Defaults to `false`. boolean -If the tabs should use the router or not. -If true, `selectedTab` does nothing. +If true, the tabs will use the router and `selectedTab` will not do anything. ## Events @@ -156,12 +154,18 @@ Emitted when the tab changes. #### ionNavDidChange +Emitted when the navigation has finished transitioning to a new component. + #### ionNavWillChange +Emitted when the navigation is about to transition to a new component. + #### ionNavWillLoad +Emitted when the navigation will load a component. + ## Methods