docs(components): update property docs and styling to match guide

This commit is contained in:
Brandy Carney
2018-02-19 16:21:08 -05:00
parent c6f915e617
commit 799f6acbaf
20 changed files with 102 additions and 99 deletions

View File

@ -12,18 +12,13 @@ Badges are inline block elements that usually appear near another element. Typic
<ion-badge color="danger">44</ion-badge> <ion-badge color="danger">44</ion-badge>
<ion-badge color="light">55</ion-badge> <ion-badge color="light">55</ion-badge>
<ion-badge color="dark">66</ion-badge> <ion-badge color="dark">66</ion-badge>
```
```html <!-- Item with badge on left and right -->
<ion-content>
<ion-list>
<ion-item> <ion-item>
<ion-badge slot="start">11</ion-badge> <ion-badge slot="start">11</ion-badge>
<ion-label>My Item</ion-label> <ion-label>My Item</ion-label>
<ion-badge slot="end">22</ion-badge> <ion-badge slot="end">22</ion-badge>
</ion-item> </ion-item>
</ion-list>
</ion-content>
``` ```

View File

@ -26,8 +26,7 @@ export class CardHeader {
@Prop() mode: 'ios' | 'md'; @Prop() mode: 'ios' | 'md';
/** /**
* If true, adds transparency to the card header. * If true, the card header will be translucent. Defaults to `false`.
* Only affects `ios` mode. Defaults to `false`.
*/ */
@Prop() translucent = false; @Prop() translucent = false;

View File

@ -27,8 +27,7 @@ Possible values are: `"ios"` or `"md"`.
boolean boolean
If true, adds transparency to the card header. If true, the card header will be translucent. Defaults to `false`.
Only affects `ios` mode. Defaults to `false`.
## Attributes ## Attributes
@ -53,8 +52,7 @@ Possible values are: `"ios"` or `"md"`.
boolean boolean
If true, adds transparency to the card header. If true, the card header will be translucent. Defaults to `false`.
Only affects `ios` mode. Defaults to `false`.

View File

@ -33,8 +33,7 @@ export class FabButton {
@Prop() href: string; @Prop() href: string;
/** /**
* If true, adds transparency to the fab. * If true, the fab button will be translucent. Defaults to `false`.
* Only affects `ios` mode. Defaults to `false`.
*/ */
@Prop() translucent = false; @Prop() translucent = false;

View File

@ -90,8 +90,7 @@ boolean
boolean boolean
If true, adds transparency to the fab. If true, the fab button will be translucent. Defaults to `false`.
Only affects `ios` mode. Defaults to `false`.
## Attributes ## Attributes
@ -148,8 +147,7 @@ boolean
boolean boolean
If true, adds transparency to the fab. If true, the fab button will be translucent. Defaults to `false`.
Only affects `ios` mode. Defaults to `false`.

View File

@ -17,10 +17,10 @@ export class Footer {
color: string; color: string;
/** /**
* If true, adds transparency to the footer. * If true, the footer will be translucent.
* Note: In order to scroll content behind the footer, the `fullscreen` * Note: In order to scroll content behind the footer, the `fullscreen`
* attribute needs to be set on the content. * attribute needs to be set on the content.
* Only affects `ios` mode. Defaults to `false`. * Defaults to `false`.
*/ */
@Prop() translucent = false; @Prop() translucent = false;

View File

@ -11,10 +11,10 @@
boolean boolean
If true, adds transparency to the footer. If true, the footer will be translucent.
Note: In order to scroll content behind the footer, the `fullscreen` Note: In order to scroll content behind the footer, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.
## Attributes ## Attributes
@ -23,10 +23,10 @@ Only affects `ios` mode. Defaults to `false`.
boolean boolean
If true, adds transparency to the footer. If true, the footer will be translucent.
Note: In order to scroll content behind the footer, the `fullscreen` Note: In order to scroll content behind the footer, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.

View File

@ -17,10 +17,10 @@ export class Header {
color: string; color: string;
/** /**
* If true, adds transparency to the header. * If true, the header will be translucent.
* Note: In order to scroll content behind the header, the `fullscreen` * Note: In order to scroll content behind the header, the `fullscreen`
* attribute needs to be set on the content. * attribute needs to be set on the content.
* Only affects `ios` mode. Defaults to `false`. * Defaults to `false`.
*/ */
@Prop() translucent = false; @Prop() translucent = false;

View File

@ -11,10 +11,10 @@
boolean boolean
If true, adds transparency to the header. If true, the header will be translucent.
Note: In order to scroll content behind the header, the `fullscreen` Note: In order to scroll content behind the header, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.
## Attributes ## Attributes
@ -23,10 +23,10 @@ Only affects `ios` mode. Defaults to `false`.
boolean boolean
If true, adds transparency to the header. If true, the header will be translucent.
Note: In order to scroll content behind the header, the `fullscreen` Note: In order to scroll content behind the header, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.

View File

@ -49,7 +49,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
number number
Duration of the spinner animation in milliseconds. Default varies based on the spinner name. Duration of the spinner animation in milliseconds. The default varies based on the spinner.
#### mode #### mode
@ -92,7 +92,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
number number
Duration of the spinner animation in milliseconds. Default varies based on the spinner name. Duration of the spinner animation in milliseconds. The default varies based on the spinner.
#### mode #### mode

View File

@ -59,7 +59,7 @@ boolean
string string
The badge for the tab button. The badge for the tab.
#### badgeStyle #### badgeStyle
@ -73,14 +73,12 @@ The badge color for the tab button.
string string
Set the root page for this tab.
#### component #### component
any any
The badge for the tab button. The component to display inside of the tab.
#### delegate #### delegate
@ -99,25 +97,28 @@ If true, the user cannot interact with the tab. Defaults to `false`.
string string
The icon for the tab button. The icon for the tab.
#### name #### name
string string
The name of the tab.
#### selected #### selected
boolean boolean
If true, the tab will be selected. Defaults to `false`.
#### show #### show
boolean boolean
If true, the tab button is visible within the If true, the tab button is visible within the tabbar. Defaults to `true`.
tabbar. Default: `true`.
#### tabsHideOnSubPages #### tabsHideOnSubPages
@ -131,7 +132,7 @@ If true, hide the tabs on child pages.
string string
The title of the tab button. The title of the tab.
## Attributes ## Attributes
@ -145,7 +146,7 @@ boolean
string string
The badge for the tab button. The badge for the tab.
#### badge-style #### badge-style
@ -159,14 +160,12 @@ The badge color for the tab button.
string string
Set the root page for this tab.
#### component #### component
any any
The badge for the tab button. The component to display inside of the tab.
#### delegate #### delegate
@ -185,25 +184,28 @@ If true, the user cannot interact with the tab. Defaults to `false`.
string string
The icon for the tab button. The icon for the tab.
#### name #### name
string string
The name of the tab.
#### selected #### selected
boolean boolean
If true, the tab will be selected. Defaults to `false`.
#### show #### show
boolean boolean
If true, the tab button is visible within the If true, the tab button is visible within the tabbar. Defaults to `true`.
tabbar. Default: `true`.
#### tabs-hide-on-sub-pages #### tabs-hide-on-sub-pages
@ -217,7 +219,7 @@ If true, hide the tabs on child pages.
string string
The title of the tab button. The title of the tab.
## Events ## Events

View File

@ -14,47 +14,62 @@ export class Tab {
@Element() el: HTMLElement; @Element() el: HTMLElement;
@State() init = false; @State() init = false;
@Prop() delegate: FrameworkDelegate;
@Prop({ mutable: true }) active = false; @Prop({ mutable: true }) active = false;
/**
* Set the root page for this tab.
*/
@Prop() btnId: string; @Prop() btnId: string;
/** /**
* The title of the tab button. * The title of the tab.
*/ */
@Prop() title: string; @Prop() title: string;
/** /**
* The icon for the tab button. * The icon for the tab.
*/ */
@Prop() icon: string; @Prop() icon: string;
/** /**
* The badge for the tab button. * The badge for the tab.
*/ */
@Prop() badge: string; @Prop() badge: string;
/**
* The badge for the tab button.
*/
@Prop() component: any;
@Prop() name: string;
/** /**
* The badge color for the tab button. * The badge color for the tab button.
*/ */
@Prop() badgeStyle = 'default'; @Prop() badgeStyle = 'default';
/**
* The component to display inside of the tab.
*/
@Prop() component: any;
/**
* The name of the tab.
*/
@Prop() 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; @Prop() disabled = false;
/** /**
* If true, the tab button is visible within the * If true, the tab will be selected. Defaults to `false`.
* tabbar. Default: `true`. */
@Prop({ mutable: true }) selected = false;
@Watch('selected')
selectedChanged(selected: boolean) {
if (selected) {
this.ionSelect.emit();
}
}
/**
* If true, the tab button is visible within the tabbar. Defaults to `true`.
*/ */
@Prop() show = true; @Prop() show = true;
@ -63,17 +78,6 @@ export class Tab {
*/ */
@Prop() tabsHideOnSubPages = false; @Prop() tabsHideOnSubPages = false;
@Prop() delegate: FrameworkDelegate;
@Prop({ mutable: true }) selected = false;
@Watch('selected')
selectedChanged(selected: boolean) {
if (selected) {
this.ionSelect.emit();
}
}
/** /**
* Emitted when the current tab is selected. * Emitted when the current tab is selected.

View File

@ -41,6 +41,8 @@ string
boolean boolean
If true, the tabbar will be translucent. Defaults to `false`.
## Attributes ## Attributes
@ -78,6 +80,8 @@ string
boolean boolean
If true, the tabbar will be translucent. Defaults to `false`.
---------------------------------------------- ----------------------------------------------

View File

@ -39,6 +39,10 @@ export class Tabbar {
@Prop() layout = 'icon-top'; @Prop() layout = 'icon-top';
@Prop() highlight = false; @Prop() highlight = false;
/**
* If true, the tabbar will be translucent. Defaults to `false`.
*/
@Prop() translucent = false; @Prop() translucent = false;
@Listen('body:keyboardWillHide') @Listen('body:keyboardWillHide')

View File

@ -143,10 +143,10 @@ Set position of the tabbar: `top`, `bottom`.
boolean boolean
If true, adds transparency to the tabbar. If true, the tabs will be translucent.
Note: In order to scroll content behind the tabbar, the `fullscreen` Note: In order to scroll content behind the tabs, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.
## Attributes ## Attributes
@ -204,10 +204,10 @@ Set position of the tabbar: `top`, `bottom`.
boolean boolean
If true, adds transparency to the tabbar. If true, the tabs will be translucent.
Note: In order to scroll content behind the tabbar, the `fullscreen` Note: In order to scroll content behind the tabs, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.
## Events ## Events

View File

@ -54,10 +54,10 @@ export class Tabs implements NavOutlet {
@Prop({ mutable: true }) tabbarHighlight: boolean; @Prop({ mutable: true }) tabbarHighlight: boolean;
/** /**
* If true, adds transparency to the tabbar. * If true, the tabs will be translucent.
* Note: In order to scroll content behind the tabbar, the `fullscreen` * Note: In order to scroll content behind the tabs, the `fullscreen`
* attribute needs to be set on the content. * attribute needs to be set on the content.
* Only affects `ios` mode. Defaults to `false`. * Defaults to `false`.
*/ */
@Prop() translucent = false; @Prop() translucent = false;

View File

@ -109,10 +109,10 @@ For more information, see [Platform Styles](/docs/theming/platform-specific-styl
boolean boolean
If true, adds transparency to the header. If true, the toolbar will be translucent.
Note: In order to scroll content behind the header, the `fullscreen` Note: In order to scroll content behind the toolbar, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.
## Attributes ## Attributes
@ -139,10 +139,10 @@ For more information, see [Platform Styles](/docs/theming/platform-specific-styl
boolean boolean
If true, adds transparency to the header. If true, the toolbar will be translucent.
Note: In order to scroll content behind the header, the `fullscreen` Note: In order to scroll content behind the toolbar, the `fullscreen`
attribute needs to be set on the content. attribute needs to be set on the content.
Only affects `ios` mode. Defaults to `false`. Defaults to `false`.

View File

@ -33,10 +33,10 @@ export class Toolbar {
@Prop() mode: 'ios' | 'md'; @Prop() mode: 'ios' | 'md';
/** /**
* If true, adds transparency to the header. * If true, the toolbar will be translucent.
* Note: In order to scroll content behind the header, the `fullscreen` * Note: In order to scroll content behind the toolbar, the `fullscreen`
* attribute needs to be set on the content. * attribute needs to be set on the content.
* Only affects `ios` mode. Defaults to `false`. * Defaults to `false`.
*/ */
@Prop() translucent = false; @Prop() translucent = false;