javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-18 19:21:34 +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
ActionSheetButton[]
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
AnimationBuilder
Animation to use when the action sheet is presented.
@ -61,7 +61,7 @@ If the actionSheet should close the keyboard
#### leaveAnimation
AnimationBuilder
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
AlertButton[]
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
AnimationBuilder
Animation to use when the alert is presented.
@ -63,7 +63,7 @@ The main title in the heading of the alert.
#### inputs
AlertInput[]
Array of input to show in the alert.
@ -75,7 +75,7 @@ boolean
#### leaveAnimation
AnimationBuilder
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
Any additional options that the picker interface can accept.
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
GestureCallback
#### direction
@ -54,27 +54,27 @@ number
#### notCaptured
GestureCallback
#### onEnd
GestureCallback
#### onMove
GestureCallback
#### onStart
GestureCallback
#### onWillStart
(_: GestureDetail) => Promise<void>
#### 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
AnimationBuilder
Animation to use when the loading indicator is presented.
@ -68,7 +68,7 @@ boolean
#### leaveAnimation
AnimationBuilder
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
The data to pass to the modal component.
@ -47,7 +47,7 @@ provided they should be separated by spaces.
#### delegate
FrameworkDelegate
#### enableBackdropDismiss
@ -59,7 +59,7 @@ If true, the modal will be dismissed when the backdrop is clicked. Defaults to `
#### enterAnimation
AnimationBuilder
Animation to use when the modal is presented.
@ -71,7 +71,7 @@ boolean
#### leaveAnimation
AnimationBuilder
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
## Attributes

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

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

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

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

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

@ -9,7 +9,7 @@
#### col
PickerColumn
## 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
PickerButton[]
Array of buttons to be displayed at the top of the picker.
#### columns
PickerColumn[]
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
AnimationBuilder
Animation to use when the picker is presented.
@ -59,7 +59,7 @@ boolean
#### leaveAnimation
AnimationBuilder
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
The data to pass to the popover component.
@ -49,7 +49,7 @@ provided they should be separated by spaces.
#### delegate
FrameworkDelegate
#### enableBackdropDismiss
@ -61,7 +61,7 @@ If true, the popover will be dismissed when the backdrop is clicked. Defaults to
#### enterAnimation
AnimationBuilder
Animation to use when the popover is presented.
@ -80,7 +80,7 @@ boolean
#### leaveAnimation
AnimationBuilder
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
{[key: string]: any}
A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed
to the defined component when rendered.

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

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

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

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

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

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

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

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

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

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

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

@ -45,7 +45,7 @@ until `dismiss()` is called.
#### enterAnimation
AnimationBuilder
Animation to use when the toast is presented.
@ -57,7 +57,7 @@ boolean
#### leaveAnimation
AnimationBuilder
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
DomRenderFn
#### footerFn
HeaderFn
Section footers and the data used within its given
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
Section headers and the data used within its given
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
ItemHeightFn
#### items
any[]
The data that builds the templates within the virtual scroll.
It's important to note that when this data has changed, then the
@ -272,22 +272,22 @@ should be avoided if possible.
#### nodeRender
ItemRenderFn
#### renderFooter
(item: any, index: number) => JSX.Element
#### renderHeader
(item: any, index: number) => JSX.Element
#### renderItem
(item: any, index: number) => JSX.Element
## Attributes