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

docs(): update component readme

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/core/src/components/action-sheet/readme.md
View File

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

20
packages/core/src/components/alert/readme.md
View File

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

51
packages/core/src/components/button/button.tsx
View File

@ -1,56 +1,7 @@
import { Component, Element, Prop } from '@stencil/core';
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({
tag: 'ion-button',
styleUrls: {

86
packages/core/src/components/button/readme.md
View File

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

10
packages/core/src/components/card-header/readme.md
View File

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

10
packages/core/src/components/checkbox/readme.md
View File

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

14
packages/core/src/components/footer/readme.md
View File

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

14
packages/core/src/components/header/readme.md
View File

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

10
packages/core/src/components/loading/readme.md
View File

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

10
packages/core/src/components/popover/readme.md
View File

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

14
packages/core/src/components/reorder/readme.md
View File

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

29
packages/core/src/components/tabs/readme.md
View File

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

11
packages/core/src/components/tabs/test/basic/readme.md Normal file
View File

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

11
packages/core/src/components/tabs/test/translucent/readme.md Normal file
View File

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

10
packages/core/src/components/toast/readme.md
View File

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

15
packages/core/src/components/toggle/readme.md
View File

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