docs(): update component readme

This commit is contained in:
Adam Bradley
2017-11-28 13:38:09 -06:00
parent 84abe7300f
commit 3f689e423f
16 changed files with 202 additions and 123 deletions

View File

@ -47,6 +47,11 @@ string
string string
#### translucent
boolean
## Attributes ## Attributes
#### actionSheetId #### actionSheetId
@ -89,6 +94,11 @@ string
string string
#### translucent
boolean
## Events ## Events
#### ionActionSheetDidDismiss #### ionActionSheetDidDismiss

View File

@ -12,6 +12,11 @@
string string
#### animate
boolean
#### buttons #### buttons
any any
@ -57,6 +62,11 @@ string
string string
#### translucent
boolean
## Attributes ## Attributes
#### alertId #### alertId
@ -64,6 +74,11 @@ string
string string
#### animate
boolean
#### buttons #### buttons
any any
@ -109,6 +124,11 @@ string
string string
#### translucent
boolean
## Events ## Events
#### ionAlertDidDismiss #### ionAlertDidDismiss

View File

@ -1,56 +1,7 @@
import { Component, Element, Prop } from '@stencil/core'; import { Component, Element, Prop } from '@stencil/core';
import { getElementClassObject } from '../../utils/theme'; import { getElementClassObject } from '../../utils/theme';
/**
* @name Button
* @module ionic
* @description
* Buttons are simple components in Ionic. They can consist of text and icons
* and be enhanced by a wide range of attributes.
*
* @usage
*
* ```html
*
* <!-- Colors -->
* <ion-button>Default</ion-button>
* <ion-button color="secondary">Secondary</ion-button>
* <ion-button color="danger">Danger</ion-button>
* <ion-button color="light">Light</ion-button>
* <ion-button color="dark">Dark</ion-button>
*
* <!-- Shapes -->
* <ion-button expand="full">Full Button</ion-button>
* <ion-button expand="block">Block Button</ion-button>
* <ion-button round>Round Button</ion-button>
*
* <!-- Outline -->
* <ion-button expand="full" fill="outline">Outline + Full</ion-button>
* <ion-button expand="block" fill="outline">Outline + Block</ion-button>
* <ion-button round fill="outline">Outline + Round</ion-button>
*
* <!-- Icons -->
* <ion-button>
* <ion-icon slot="start" name="star"></ion-icon>
* Left Icon
* </ion-button>
*
* <ion-button>
* Right Icon
* <ion-icon slot="end" name="star"></ion-icon>
* </ion-button>
*
* <ion-button>
* <ion-icon slot="icon-only" name="star"></ion-icon>
* </ion-button>
*
* <!-- Sizes -->
* <ion-button size="large">Large</ion-button>
* <ion-button>Default</ion-button>
* <ion-button size="small">Small</ion-button>
* ```
*
*/
@Component({ @Component({
tag: 'ion-button', tag: 'ion-button',
styleUrls: { styleUrls: {

View File

@ -59,39 +59,29 @@ and be enhanced by a wide range of attributes.
## Properties ## Properties
#### block
boolean
#### buttonType #### buttonType
string string
#### clear
boolean
#### color #### color
string string
#### default
boolean
#### disabled #### disabled
boolean boolean
#### full #### expand
boolean any
#### fill
any
#### href #### href
@ -104,34 +94,19 @@ string
boolean boolean
#### large
boolean
#### mode #### mode
any any
#### outline
boolean
#### round #### round
boolean boolean
#### small #### size
boolean any
#### solid
boolean
#### strong #### strong
@ -141,39 +116,29 @@ boolean
## Attributes ## Attributes
#### block
boolean
#### buttonType #### buttonType
string string
#### clear
boolean
#### color #### color
string string
#### default
boolean
#### disabled #### disabled
boolean boolean
#### full #### expand
boolean any
#### fill
any
#### href #### href
@ -186,34 +151,19 @@ string
boolean boolean
#### large
boolean
#### mode #### mode
any any
#### outline
boolean
#### round #### round
boolean boolean
#### small #### size
boolean any
#### solid
boolean
#### strong #### strong

View File

@ -17,6 +17,11 @@ string
any any
#### translucent
boolean
## Attributes ## Attributes
#### color #### color
@ -29,6 +34,11 @@ string
any any
#### translucent
boolean
---------------------------------------------- ----------------------------------------------

View File

@ -52,6 +52,11 @@ boolean
any any
#### name
string
#### value #### value
string string
@ -79,6 +84,11 @@ boolean
any any
#### name
string
#### value #### value
string string

View File

@ -5,6 +5,20 @@
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
## Properties
#### translucent
boolean
## Attributes
#### translucent
boolean
---------------------------------------------- ----------------------------------------------

View File

@ -5,6 +5,20 @@
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
## Properties
#### translucent
boolean
## Attributes
#### translucent
boolean
---------------------------------------------- ----------------------------------------------

View File

@ -47,6 +47,11 @@ string
boolean boolean
#### translucent
boolean
## Attributes ## Attributes
#### content #### content
@ -89,6 +94,11 @@ string
boolean boolean
#### translucent
boolean
## Events ## Events
#### ionLoadingDidDismiss #### ionLoadingDidDismiss

View File

@ -62,6 +62,11 @@ string
boolean boolean
#### translucent
boolean
## Attributes ## Attributes
#### color #### color
@ -119,6 +124,11 @@ string
boolean boolean
#### translucent
boolean
## Events ## Events
#### ionPopoverDidDismiss #### ionPopoverDidDismiss

View File

@ -5,6 +5,20 @@
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
## Properties
#### enabled
boolean
## Attributes
#### enabled
boolean
---------------------------------------------- ----------------------------------------------

View File

@ -5,6 +5,35 @@
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
## Properties
#### selected
boolean
#### tab
any
## Attributes
#### selected
boolean
#### tab
any
## Events
#### ionTabbarClick
---------------------------------------------- ----------------------------------------------

View File

@ -0,0 +1,11 @@
# page-tab
<!-- Auto Generated Below -->
----------------------------------------------
*Built by [StencilJS](https://stenciljs.com/)*

View File

@ -0,0 +1,11 @@
# translucent-page-tab
<!-- Auto Generated Below -->
----------------------------------------------
*Built by [StencilJS](https://stenciljs.com/)*

View File

@ -57,6 +57,11 @@ boolean
string string
#### translucent
boolean
## Attributes ## Attributes
#### closeButtonText #### closeButtonText
@ -109,6 +114,11 @@ boolean
string string
#### translucent
boolean
## Events ## Events
#### ionToastDidDismiss #### ionToastDidDismiss

View File

@ -52,6 +52,11 @@ boolean
any any
#### name
string
#### value #### value
string string
@ -79,6 +84,11 @@ boolean
any any
#### name
string
#### value #### value
string string
@ -98,11 +108,6 @@ string
#### ionStyle #### ionStyle
## Methods
#### toggle()
---------------------------------------------- ----------------------------------------------