javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-19 03:32:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): update stencil docs generation readmes

Browse Source
This commit is contained in:
Adam Bradley
2018-05-30 12:02:31 -05:00
parent 128ed60510
commit 9872a6c7ee
20 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,7 +18,7 @@ A button's `role` property can either be `destructive` or `cancel`. Buttons with
#### buttons #### buttons
ActionSheetButton[]
An array of buttons for the action sheet. An array of buttons for the action sheet.
@ -40,7 +40,7 @@ If true, the action sheet will be dismissed when the backdrop is clicked. Defaul
#### enterAnimation #### enterAnimation
AnimationBuilder
Animation to use when the action sheet is presented. Animation to use when the action sheet is presented.
@ -61,7 +61,7 @@ If the actionSheet should close the keyboard
#### leaveAnimation #### leaveAnimation
AnimationBuilder
Animation to use when the action sheet is dismissed. Animation to use when the action sheet is dismissed.

8
core/src/components/alert/readme.md
View File

@ -27,7 +27,7 @@ Alerts can also include several different inputs whose data can be passed back t
#### buttons #### buttons
AlertButton[]
Array of buttons to be added to the alert. Array of buttons to be added to the alert.
@ -49,7 +49,7 @@ If true, the alert will be dismissed when the backdrop is clicked. Defaults to `
#### enterAnimation #### enterAnimation
AnimationBuilder
Animation to use when the alert is presented. Animation to use when the alert is presented.
@ -63,7 +63,7 @@ The main title in the heading of the alert.
#### inputs #### inputs
AlertInput[]
Array of input to show in the alert. Array of input to show in the alert.
@ -75,7 +75,7 @@ boolean
#### leaveAnimation #### leaveAnimation
AnimationBuilder
Animation to use when the alert is dismissed. Animation to use when the alert is dismissed.

2
core/src/components/datetime/readme.md
View File

@ -351,7 +351,7 @@ parse format. Defaults to use `displayFormat`.
#### pickerOptions #### pickerOptions
PickerOptions
Any additional options that the picker interface can accept. Any additional options that the picker interface can accept.
See the [Picker API docs](../../picker/Picker) for the picker options. See the [Picker API docs](../../picker/Picker) for the picker options.

12
core/src/components/gesture/readme.md
View File

@ -19,7 +19,7 @@ boolean
#### canStart #### canStart
GestureCallback
#### direction #### direction
@ -54,27 +54,27 @@ number
#### notCaptured #### notCaptured
GestureCallback
#### onEnd #### onEnd
GestureCallback
#### onMove #### onMove
GestureCallback
#### onStart #### onStart
GestureCallback
#### onWillStart #### onWillStart
(_: GestureDetail) => Promise<void>
#### passive #### passive

4
core/src/components/loading/readme.md
View File

@ -56,7 +56,7 @@ If true, the loading indicator will be dismissed when the backdrop is clicked. D
#### enterAnimation #### enterAnimation
AnimationBuilder
Animation to use when the loading indicator is presented. Animation to use when the loading indicator is presented.
@ -68,7 +68,7 @@ boolean
#### leaveAnimation #### leaveAnimation
AnimationBuilder
Animation to use when the loading indicator is dismissed. Animation to use when the loading indicator is dismissed.

8
core/src/components/modal/readme.md
View File

@ -32,7 +32,7 @@ The component to display inside of the modal.
#### componentProps #### componentProps
ComponentProps
The data to pass to the modal component. The data to pass to the modal component.
@ -47,7 +47,7 @@ provided they should be separated by spaces.
#### delegate #### delegate
FrameworkDelegate
#### enableBackdropDismiss #### enableBackdropDismiss
@ -59,7 +59,7 @@ If true, the modal will be dismissed when the backdrop is clicked. Defaults to `
#### enterAnimation #### enterAnimation
AnimationBuilder
Animation to use when the modal is presented. Animation to use when the modal is presented.
@ -71,7 +71,7 @@ boolean
#### leaveAnimation #### leaveAnimation
AnimationBuilder
Animation to use when the modal is dismissed. Animation to use when the modal is dismissed.

2
core/src/components/nav-push/readme.md
View File

@ -14,7 +14,7 @@ string
#### componentProps #### componentProps
ComponentProps
## Attributes ## Attributes

2
core/src/components/nav-set-root/readme.md
View File

@ -14,7 +14,7 @@ string
#### componentProps #### componentProps
ComponentProps
## Attributes ## Attributes

4
core/src/components/nav/readme.md
View File

@ -14,7 +14,7 @@ boolean
#### delegate #### delegate
FrameworkDelegate
#### root #### root
@ -24,7 +24,7 @@ string
#### rootParams #### rootParams
ComponentProps
#### swipeBackEnabled #### swipeBackEnabled

2
core/src/components/picker-column/readme.md
View File

@ -9,7 +9,7 @@
#### col #### col
PickerColumn
## Attributes ## Attributes

8
core/src/components/picker/readme.md
View File

@ -11,14 +11,14 @@ A Picker is a dialog that displays a row of buttons and columns underneath. It a
#### buttons #### buttons
PickerButton[]
Array of buttons to be displayed at the top of the picker. Array of buttons to be displayed at the top of the picker.
#### columns #### columns
PickerColumn[]
Array of columns to be displayed in the picker. Array of columns to be displayed in the picker.
@ -47,7 +47,7 @@ If true, the picker will be dismissed when the backdrop is clicked. Defaults to
#### enterAnimation #### enterAnimation
AnimationBuilder
Animation to use when the picker is presented. Animation to use when the picker is presented.
@ -59,7 +59,7 @@ boolean
#### leaveAnimation #### leaveAnimation
AnimationBuilder
Animation to use when the picker is dismissed. Animation to use when the picker is dismissed.

8
core/src/components/popover/readme.md
View File

@ -34,7 +34,7 @@ The component to display inside of the popover.
#### componentProps #### componentProps
ComponentProps
The data to pass to the popover component. The data to pass to the popover component.
@ -49,7 +49,7 @@ provided they should be separated by spaces.
#### delegate #### delegate
FrameworkDelegate
#### enableBackdropDismiss #### enableBackdropDismiss
@ -61,7 +61,7 @@ If true, the popover will be dismissed when the backdrop is clicked. Defaults to
#### enterAnimation #### enterAnimation
AnimationBuilder
Animation to use when the popover is presented. Animation to use when the popover is presented.
@ -80,7 +80,7 @@ boolean
#### leaveAnimation #### leaveAnimation
AnimationBuilder
Animation to use when the popover is dismissed. Animation to use when the popover is dismissed.

2
core/src/components/route/readme.md
View File

@ -20,7 +20,7 @@ in ion-tabs it actually refers to the name of the `ion-tab` to select.
#### componentProps #### componentProps
{[key: string]: any}
A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed
to the defined component when rendered. to the defined component when rendered.

4
core/src/components/router-outlet/readme.md
View File

@ -14,12 +14,12 @@ boolean
#### animationBuilder #### animationBuilder
AnimationBuilder
#### delegate #### delegate
FrameworkDelegate
## Attributes ## Attributes

2
core/src/components/select-popover/readme.md
View File

@ -19,7 +19,7 @@ string
#### options #### options
SelectPopoverOption[]
#### subHeader #### subHeader

2
core/src/components/tab-button/readme.md
View File

@ -14,7 +14,7 @@ boolean
#### tab #### tab
HTMLIonTabElement
## Attributes ## Attributes

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

@ -83,7 +83,7 @@ The component to display inside of the tab.
#### delegate #### delegate
FrameworkDelegate
#### disabled #### disabled

4
core/src/components/tabbar/readme.md
View File

@ -29,12 +29,12 @@ boolean
#### selectedTab #### selectedTab
HTMLIonTabElement
#### tabs #### tabs
HTMLIonTabElement[]
#### translucent #### translucent

4
core/src/components/toast/readme.md
View File

@ -45,7 +45,7 @@ until `dismiss()` is called.
#### enterAnimation #### enterAnimation
AnimationBuilder
Animation to use when the toast is presented. Animation to use when the toast is presented.
@ -57,7 +57,7 @@ boolean
#### leaveAnimation #### leaveAnimation
AnimationBuilder
Animation to use when the toast is dismissed. Animation to use when the toast is dismissed.

18
core/src/components/virtual-scroll/readme.md
View File

@ -227,12 +227,12 @@ initial dimensions before the item has been rendered. Default is
#### domRender #### domRender
DomRenderFn
#### footerFn #### footerFn
HeaderFn
Section footers and the data used within its given Section footers and the data used within its given
template can be dynamically created by passing a function to `footerFn`. template can be dynamically created by passing a function to `footerFn`.
@ -243,7 +243,7 @@ must return `null` if a footer cell shouldn't be created.
#### headerFn #### headerFn
HeaderFn
Section headers and the data used within its given Section headers and the data used within its given
template can be dynamically created by passing a function to `headerFn`. template can be dynamically created by passing a function to `headerFn`.
@ -257,12 +257,12 @@ and what data to give to the header template. The function must return
#### itemHeight #### itemHeight
ItemHeightFn
#### items #### items
any[]
The data that builds the templates within the virtual scroll. The data that builds the templates within the virtual scroll.
It's important to note that when this data has changed, then the It's important to note that when this data has changed, then the
@ -272,22 +272,22 @@ should be avoided if possible.
#### nodeRender #### nodeRender
ItemRenderFn
#### renderFooter #### renderFooter
(item: any, index: number) => JSX.Element
#### renderHeader #### renderHeader
(item: any, index: number) => JSX.Element
#### renderItem #### renderItem
(item: any, index: number) => JSX.Element
## Attributes ## Attributes