javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-11-10 00:27:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(all): docs for all missing props

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-10-11 16:02:15 -05:00
committed by Manu MA
parent 53305741a0
commit a72fced6fe
119 changed files with 1025 additions and 656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
core/src/components/tab/readme.md
View File

@ -12,22 +12,22 @@ See the [Tabs API Docs](../Tabs/) for more details on configuring Tabs.
## Properties
| Property | Attribute | Description | Type |
| -------------------- | ------------------------ | ------------------------------------------------------------------------- | ------------------- |
| `active` | `active` | If true, sets the tab as the active tab. | `boolean` |
| `badgeColor` | `badge-color` | The badge color for the tab button. | `Color` |
| `badge` | `badge` | The badge for the tab. | `string` |
| `btnId` | `btn-id` | hidden | `string` |
| `component` | `component` | The component to display inside of the tab. | `ComponentRef` |
| `delegate` | -- | hidden | `FrameworkDelegate` |
| `disabled` | `disabled` | If true, the user cannot interact with the tab. Defaults to `false`. | `boolean` |
| `href` | `href` | The URL which will be used as the `href` within this tab's button anchor. | `string` |
| `icon` | `icon` | The icon for the tab. | `string` |
| `label` | `label` | The label of the tab. | `string` |
| `name` | `name` | The name of the tab. | `string` |
| `selected` | `selected` | If true, the tab will be selected. Defaults to `false`. | `boolean` |
| `show` | `show` | If true, the tab button is visible within the tabbar. Defaults to `true`. | `boolean` |
| `tabsHideOnSubPages` | `tabs-hide-on-sub-pages` | If true, hide the tabs on child pages. | `boolean` |
| Property | Attribute | Description | Type |
| -------------------- | ------------------------ | --------------------------------------------------------------------------- | ------------------- |
| `active` | `active` | If `true`, sets the tab as the active tab. | `boolean` |
| `badgeColor` | `badge-color` | The badge color for the tab button. | `Color` |
| `badge` | `badge` | The badge for the tab. | `string` |
| `btnId` | `btn-id` | hidden | `string` |
| `component` | `component` | The component to display inside of the tab. | `ComponentRef` |
| `delegate` | -- | hidden | `FrameworkDelegate` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the tab. Defaults to `false`. | `boolean` |
| `href` | `href` | The URL which will be used as the `href` within this tab's button anchor. | `string` |
| `icon` | `icon` | The icon for the tab. | `string` |
| `label` | `label` | The label of the tab. | `string` |
| `name` | `name` | The name of the tab. | `string` |
| `selected` | `selected` | If `true`, the tab will be selected. Defaults to `false`. | `boolean` |
| `show` | `show` | If `true`, the tab button is visible within the tabbar. Defaults to `true`. | `boolean` |
| `tabsHideOnSubPages` | `tabs-hide-on-sub-pages` | If `true`, hide the tabs on child pages. | `boolean` |
## Events

10
core/src/components/tab/tab.tsx
View File

@ -14,7 +14,7 @@ export class Tab implements ComponentInterface {
@Element() el!: HTMLIonTabElement;
/**
* If true, sets the tab as the active tab.
* If `true`, sets the tab as the active tab.
*/
@Prop({ mutable: true }) active = false;
@ -60,12 +60,12 @@ export class Tab implements ComponentInterface {
@Prop({ mutable: true }) name?: string;
/**
* If true, the user cannot interact with the tab. Defaults to `false`.
* If `true`, the user cannot interact with the tab. Defaults to `false`.
*/
@Prop() disabled = false;
/**
* If true, the tab will be selected. Defaults to `false`.
* If `true`, the tab will be selected. Defaults to `false`.
*/
@Prop() selected = false;
@ -77,12 +77,12 @@ export class Tab implements ComponentInterface {
}
/**
* If true, the tab button is visible within the tabbar. Defaults to `true`.
* If `true`, the tab button is visible within the tabbar. Defaults to `true`.
*/
@Prop() show = true;
/**
* If true, hide the tabs on child pages.
* If `true`, hide the tabs on child pages.
*/
@Prop() tabsHideOnSubPages = false;