diff --git a/core/src/components/action-sheet/readme.md b/core/src/components/action-sheet/readme.md index 80849ae014..6e4bce5e08 100644 --- a/core/src/components/action-sheet/readme.md +++ b/core/src/components/action-sheet/readme.md @@ -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. diff --git a/core/src/components/alert/readme.md b/core/src/components/alert/readme.md index b175e6d03e..a96c2de1e3 100644 --- a/core/src/components/alert/readme.md +++ b/core/src/components/alert/readme.md @@ -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. diff --git a/core/src/components/datetime/readme.md b/core/src/components/datetime/readme.md index 216e083aff..1dedcd4d76 100644 --- a/core/src/components/datetime/readme.md +++ b/core/src/components/datetime/readme.md @@ -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. diff --git a/core/src/components/gesture/readme.md b/core/src/components/gesture/readme.md index 13113d74b8..9a6d1df376 100644 --- a/core/src/components/gesture/readme.md +++ b/core/src/components/gesture/readme.md @@ -19,7 +19,7 @@ boolean #### canStart - +GestureCallback #### direction @@ -54,27 +54,27 @@ number #### notCaptured - +GestureCallback #### onEnd - +GestureCallback #### onMove - +GestureCallback #### onStart - +GestureCallback #### onWillStart - +(_: GestureDetail) => Promise #### passive diff --git a/core/src/components/loading/readme.md b/core/src/components/loading/readme.md index 110fcfa0d9..529199050a 100644 --- a/core/src/components/loading/readme.md +++ b/core/src/components/loading/readme.md @@ -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. diff --git a/core/src/components/modal/readme.md b/core/src/components/modal/readme.md index 73bd3c48e4..587d7793ec 100644 --- a/core/src/components/modal/readme.md +++ b/core/src/components/modal/readme.md @@ -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. diff --git a/core/src/components/nav-push/readme.md b/core/src/components/nav-push/readme.md index c22d00e616..c78b9fd1e7 100644 --- a/core/src/components/nav-push/readme.md +++ b/core/src/components/nav-push/readme.md @@ -14,7 +14,7 @@ string #### componentProps - +ComponentProps ## Attributes diff --git a/core/src/components/nav-set-root/readme.md b/core/src/components/nav-set-root/readme.md index 3790c0a040..4f487b568d 100644 --- a/core/src/components/nav-set-root/readme.md +++ b/core/src/components/nav-set-root/readme.md @@ -14,7 +14,7 @@ string #### componentProps - +ComponentProps ## Attributes diff --git a/core/src/components/nav/readme.md b/core/src/components/nav/readme.md index 3fc55f3293..df74f504c0 100644 --- a/core/src/components/nav/readme.md +++ b/core/src/components/nav/readme.md @@ -14,7 +14,7 @@ boolean #### delegate - +FrameworkDelegate #### root @@ -24,7 +24,7 @@ string #### rootParams - +ComponentProps #### swipeBackEnabled diff --git a/core/src/components/picker-column/readme.md b/core/src/components/picker-column/readme.md index a75313bd4c..88cfd3525a 100644 --- a/core/src/components/picker-column/readme.md +++ b/core/src/components/picker-column/readme.md @@ -9,7 +9,7 @@ #### col - +PickerColumn ## Attributes diff --git a/core/src/components/picker/readme.md b/core/src/components/picker/readme.md index d134d38305..5a92806846 100644 --- a/core/src/components/picker/readme.md +++ b/core/src/components/picker/readme.md @@ -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. diff --git a/core/src/components/popover/readme.md b/core/src/components/popover/readme.md index e449ee55d5..59729ad60f 100644 --- a/core/src/components/popover/readme.md +++ b/core/src/components/popover/readme.md @@ -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. diff --git a/core/src/components/route/readme.md b/core/src/components/route/readme.md index bd7a9a8e9c..5eb5f574cb 100644 --- a/core/src/components/route/readme.md +++ b/core/src/components/route/readme.md @@ -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. diff --git a/core/src/components/router-outlet/readme.md b/core/src/components/router-outlet/readme.md index 6a62e81b18..fd0deb9555 100644 --- a/core/src/components/router-outlet/readme.md +++ b/core/src/components/router-outlet/readme.md @@ -14,12 +14,12 @@ boolean #### animationBuilder - +AnimationBuilder #### delegate - +FrameworkDelegate ## Attributes diff --git a/core/src/components/select-popover/readme.md b/core/src/components/select-popover/readme.md index 00f42206b4..f2e34d7f2a 100644 --- a/core/src/components/select-popover/readme.md +++ b/core/src/components/select-popover/readme.md @@ -19,7 +19,7 @@ string #### options - +SelectPopoverOption[] #### subHeader diff --git a/core/src/components/tab-button/readme.md b/core/src/components/tab-button/readme.md index c08d26d953..88671a81d8 100644 --- a/core/src/components/tab-button/readme.md +++ b/core/src/components/tab-button/readme.md @@ -14,7 +14,7 @@ boolean #### tab - +HTMLIonTabElement ## Attributes diff --git a/core/src/components/tab/readme.md b/core/src/components/tab/readme.md index 4585ca2a8a..f6e04cbd74 100644 --- a/core/src/components/tab/readme.md +++ b/core/src/components/tab/readme.md @@ -83,7 +83,7 @@ The component to display inside of the tab. #### delegate - +FrameworkDelegate #### disabled diff --git a/core/src/components/tabbar/readme.md b/core/src/components/tabbar/readme.md index 7882c09584..677d89fdfe 100644 --- a/core/src/components/tabbar/readme.md +++ b/core/src/components/tabbar/readme.md @@ -29,12 +29,12 @@ boolean #### selectedTab - +HTMLIonTabElement #### tabs - +HTMLIonTabElement[] #### translucent diff --git a/core/src/components/toast/readme.md b/core/src/components/toast/readme.md index 6118184498..a86ec0d6a2 100644 --- a/core/src/components/toast/readme.md +++ b/core/src/components/toast/readme.md @@ -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. diff --git a/core/src/components/virtual-scroll/readme.md b/core/src/components/virtual-scroll/readme.md index b92efff921..e67b0b4509 100644 --- a/core/src/components/virtual-scroll/readme.md +++ b/core/src/components/virtual-scroll/readme.md @@ -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