From f7c1d04d34627b79267bb7a8a32ea517cb7dc78c Mon Sep 17 00:00:00 2001 From: Adam Bradley Date: Tue, 21 Nov 2017 20:39:16 -0600 Subject: [PATCH] docs(readme): init component readme.md docs --- .../action-sheet-controller/readme.md | 16 + .../src/components/action-sheet/readme.md | 115 +++++++ .../src/components/alert-controller/readme.md | 16 + packages/core/src/components/alert/readme.md | 143 +++++++++ .../components/animation-controller/readme.md | 16 + packages/core/src/components/app/readme.md | 25 ++ packages/core/src/components/avatar/readme.md | 11 + .../core/src/components/backdrop/readme.md | 11 + packages/core/src/components/badge/readme.md | 35 +++ packages/core/src/components/button/readme.md | 175 +++++++++++ .../core/src/components/buttons/readme.md | 11 + .../src/components/card-content/readme.md | 35 +++ .../core/src/components/card-header/readme.md | 35 +++ .../src/components/card-subtitle/readme.md | 35 +++ .../core/src/components/card-title/readme.md | 35 +++ packages/core/src/components/card/readme.md | 35 +++ .../core/src/components/checkbox/readme.md | 79 +++++ .../core/src/components/chip-button/readme.md | 65 ++++ packages/core/src/components/chip/readme.md | 35 +++ .../core/src/components/content/readme.md | 66 ++++ .../core/src/components/datetime/readme.md | 210 +++++++++++++ packages/core/src/components/fab/readme.md | 16 + packages/core/src/components/footer/readme.md | 11 + .../components/gesture-controller/readme.md | 11 + .../core/src/components/gesture/readme.md | 212 +++++++++++++ packages/core/src/components/grid/readme.md | 11 + packages/core/src/components/header/readme.md | 11 + .../src/components/infinite-scroll/readme.md | 35 +++ packages/core/src/components/input/readme.md | 286 ++++++++++++++++++ .../src/components/item-divider/readme.md | 35 +++ .../src/components/item-sliding/readme.md | 55 ++++ packages/core/src/components/item/readme.md | 45 +++ .../components/keyboard-controller/readme.md | 25 ++ packages/core/src/components/label/readme.md | 75 +++++ .../core/src/components/list-header/readme.md | 35 +++ packages/core/src/components/list/readme.md | 22 ++ .../components/loading-controller/readme.md | 16 + .../core/src/components/loading/readme.md | 115 +++++++ .../src/components/menu-controller/readme.md | 58 ++++ packages/core/src/components/menu/readme.md | 123 ++++++++ .../src/components/modal-controller/readme.md | 16 + packages/core/src/components/modal/readme.md | 135 +++++++++ .../src/components/nav-controller/readme.md | 57 ++++ packages/core/src/components/nav/readme.md | 118 ++++++++ packages/core/src/components/note/readme.md | 35 +++ packages/core/src/components/page/readme.md | 11 + .../components/picker-controller/readme.md | 16 + packages/core/src/components/picker/readme.md | 25 ++ .../components/popover-controller/readme.md | 16 + .../core/src/components/popover/readme.md | 145 +++++++++ .../core/src/components/radio-group/readme.md | 58 ++++ packages/core/src/components/radio/readme.md | 93 ++++++ packages/core/src/components/range/readme.md | 113 +++++++ .../core/src/components/reorder/readme.md | 11 + packages/core/src/components/router/readme.md | 35 +++ packages/core/src/components/scroll/readme.md | 87 ++++++ .../core/src/components/searchbar/readme.md | 152 ++++++++++ .../src/components/segment-button/readme.md | 70 +++++ .../core/src/components/segment/readme.md | 60 ++++ .../src/components/select-option/readme.md | 55 ++++ packages/core/src/components/select/readme.md | 40 +++ .../src/components/skeleton-text/readme.md | 25 ++ packages/core/src/components/slides/readme.md | 11 + .../core/src/components/spinner/readme.md | 65 ++++ .../core/src/components/split-pane/readme.md | 48 +++ packages/core/src/components/tabs/readme.md | 11 + .../core/src/components/thumbnail/readme.md | 11 + packages/core/src/components/title/readme.md | 11 + .../src/components/toast-controller/readme.md | 16 + packages/core/src/components/toast/readme.md | 135 +++++++++ packages/core/src/components/toggle/readme.md | 84 +++++ .../core/src/components/toolbar/readme.md | 55 ++++ packages/core/src/components/util/readme.md | 11 + 73 files changed, 4232 insertions(+) create mode 100644 packages/core/src/components/action-sheet-controller/readme.md create mode 100644 packages/core/src/components/action-sheet/readme.md create mode 100644 packages/core/src/components/alert-controller/readme.md create mode 100644 packages/core/src/components/alert/readme.md create mode 100644 packages/core/src/components/animation-controller/readme.md create mode 100644 packages/core/src/components/app/readme.md create mode 100644 packages/core/src/components/avatar/readme.md create mode 100644 packages/core/src/components/backdrop/readme.md create mode 100644 packages/core/src/components/badge/readme.md create mode 100644 packages/core/src/components/button/readme.md create mode 100644 packages/core/src/components/buttons/readme.md create mode 100644 packages/core/src/components/card-content/readme.md create mode 100644 packages/core/src/components/card-header/readme.md create mode 100644 packages/core/src/components/card-subtitle/readme.md create mode 100644 packages/core/src/components/card-title/readme.md create mode 100644 packages/core/src/components/card/readme.md create mode 100644 packages/core/src/components/checkbox/readme.md create mode 100644 packages/core/src/components/chip-button/readme.md create mode 100644 packages/core/src/components/chip/readme.md create mode 100644 packages/core/src/components/content/readme.md create mode 100644 packages/core/src/components/datetime/readme.md create mode 100644 packages/core/src/components/fab/readme.md create mode 100644 packages/core/src/components/footer/readme.md create mode 100644 packages/core/src/components/gesture-controller/readme.md create mode 100644 packages/core/src/components/gesture/readme.md create mode 100644 packages/core/src/components/grid/readme.md create mode 100644 packages/core/src/components/header/readme.md create mode 100644 packages/core/src/components/infinite-scroll/readme.md create mode 100644 packages/core/src/components/input/readme.md create mode 100644 packages/core/src/components/item-divider/readme.md create mode 100644 packages/core/src/components/item-sliding/readme.md create mode 100644 packages/core/src/components/item/readme.md create mode 100644 packages/core/src/components/keyboard-controller/readme.md create mode 100644 packages/core/src/components/label/readme.md create mode 100644 packages/core/src/components/list-header/readme.md create mode 100644 packages/core/src/components/list/readme.md create mode 100644 packages/core/src/components/loading-controller/readme.md create mode 100644 packages/core/src/components/loading/readme.md create mode 100644 packages/core/src/components/menu-controller/readme.md create mode 100644 packages/core/src/components/menu/readme.md create mode 100644 packages/core/src/components/modal-controller/readme.md create mode 100644 packages/core/src/components/modal/readme.md create mode 100644 packages/core/src/components/nav-controller/readme.md create mode 100644 packages/core/src/components/nav/readme.md create mode 100644 packages/core/src/components/note/readme.md create mode 100644 packages/core/src/components/page/readme.md create mode 100644 packages/core/src/components/picker-controller/readme.md create mode 100644 packages/core/src/components/picker/readme.md create mode 100644 packages/core/src/components/popover-controller/readme.md create mode 100644 packages/core/src/components/popover/readme.md create mode 100644 packages/core/src/components/range/readme.md create mode 100644 packages/core/src/components/reorder/readme.md create mode 100644 packages/core/src/components/router/readme.md create mode 100644 packages/core/src/components/scroll/readme.md create mode 100644 packages/core/src/components/searchbar/readme.md create mode 100644 packages/core/src/components/segment-button/readme.md create mode 100644 packages/core/src/components/segment/readme.md create mode 100644 packages/core/src/components/select-option/readme.md create mode 100644 packages/core/src/components/select/readme.md create mode 100644 packages/core/src/components/skeleton-text/readme.md create mode 100644 packages/core/src/components/slides/readme.md create mode 100644 packages/core/src/components/spinner/readme.md create mode 100644 packages/core/src/components/split-pane/readme.md create mode 100644 packages/core/src/components/tabs/readme.md create mode 100644 packages/core/src/components/thumbnail/readme.md create mode 100644 packages/core/src/components/title/readme.md create mode 100644 packages/core/src/components/toast-controller/readme.md create mode 100644 packages/core/src/components/toast/readme.md create mode 100644 packages/core/src/components/toggle/readme.md create mode 100644 packages/core/src/components/toolbar/readme.md create mode 100644 packages/core/src/components/util/readme.md diff --git a/packages/core/src/components/action-sheet-controller/readme.md b/packages/core/src/components/action-sheet-controller/readme.md new file mode 100644 index 0000000000..defcf963ea --- /dev/null +++ b/packages/core/src/components/action-sheet-controller/readme.md @@ -0,0 +1,16 @@ +# ion-action-sheet-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/action-sheet/readme.md b/packages/core/src/components/action-sheet/readme.md new file mode 100644 index 0000000000..94437967a5 --- /dev/null +++ b/packages/core/src/components/action-sheet/readme.md @@ -0,0 +1,115 @@ +# ion-action-sheet + + + + + + +## Properties + +#### actionSheetId + +string + + +#### buttons + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### subTitle + +string + + +#### title + +string + + +## Attributes + +#### actionSheetId + +string + + +#### buttons + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### subTitle + +string + + +#### title + +string + + +## Events + +#### ionActionSheetDidDismiss + + +#### ionActionSheetDidLoad + + +#### ionActionSheetDidPresent + + +#### ionActionSheetDidUnload + + +#### ionActionSheetWillDismiss + + +#### ionActionSheetWillPresent + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/alert-controller/readme.md b/packages/core/src/components/alert-controller/readme.md new file mode 100644 index 0000000000..ab5310d058 --- /dev/null +++ b/packages/core/src/components/alert-controller/readme.md @@ -0,0 +1,16 @@ +# ion-alert-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/alert/readme.md b/packages/core/src/components/alert/readme.md new file mode 100644 index 0000000000..7efc2b33f9 --- /dev/null +++ b/packages/core/src/components/alert/readme.md @@ -0,0 +1,143 @@ +# ion-alert + + + + + + +## Properties + +#### alertId + +string + + +#### buttons + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### inputs + +any + + +#### message + +string + + +#### subTitle + +string + + +#### title + +string + + +## Attributes + +#### alertId + +string + + +#### buttons + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### inputs + +any + + +#### message + +string + + +#### subTitle + +string + + +#### title + +string + + +## Events + +#### ionAlertDidDismiss + + +#### ionAlertDidLoad + + +#### ionAlertDidPresent + + +#### ionAlertDidUnload + + +#### ionAlertWillDismiss + + +#### ionAlertWillPresent + + +## Methods + +#### dismiss() + + +#### present() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/animation-controller/readme.md b/packages/core/src/components/animation-controller/readme.md new file mode 100644 index 0000000000..e0656d8306 --- /dev/null +++ b/packages/core/src/components/animation-controller/readme.md @@ -0,0 +1,16 @@ +# ion-animation-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/app/readme.md b/packages/core/src/components/app/readme.md new file mode 100644 index 0000000000..e6e9fcede7 --- /dev/null +++ b/packages/core/src/components/app/readme.md @@ -0,0 +1,25 @@ +# ion-app + + + + + + +## Methods + +#### getActiveNavs() + + +#### getNavByIdOrName() + + +#### getRootNavs() + + +#### isScrolling() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/avatar/readme.md b/packages/core/src/components/avatar/readme.md new file mode 100644 index 0000000000..159bb7f14b --- /dev/null +++ b/packages/core/src/components/avatar/readme.md @@ -0,0 +1,11 @@ +# ion-avatar + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/backdrop/readme.md b/packages/core/src/components/backdrop/readme.md new file mode 100644 index 0000000000..53917b2285 --- /dev/null +++ b/packages/core/src/components/backdrop/readme.md @@ -0,0 +1,11 @@ +# ion-backdrop + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/badge/readme.md b/packages/core/src/components/badge/readme.md new file mode 100644 index 0000000000..3dd190267a --- /dev/null +++ b/packages/core/src/components/badge/readme.md @@ -0,0 +1,35 @@ +# ion-badge + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/button/readme.md b/packages/core/src/components/button/readme.md new file mode 100644 index 0000000000..9703d6ce16 --- /dev/null +++ b/packages/core/src/components/button/readme.md @@ -0,0 +1,175 @@ +# ion-button + + + + + + +## Properties + +#### block + +boolean + + +#### buttonType + +string + + +#### clear + +boolean + + +#### color + +string + + +#### default + +boolean + + +#### disabled + +boolean + + +#### full + +boolean + + +#### href + +string + + +#### itemButton + +boolean + + +#### large + +boolean + + +#### mode + +any + + +#### outline + +boolean + + +#### round + +boolean + + +#### small + +boolean + + +#### solid + +boolean + + +#### strong + +boolean + + +## Attributes + +#### block + +boolean + + +#### buttonType + +string + + +#### clear + +boolean + + +#### color + +string + + +#### default + +boolean + + +#### disabled + +boolean + + +#### full + +boolean + + +#### href + +string + + +#### itemButton + +boolean + + +#### large + +boolean + + +#### mode + +any + + +#### outline + +boolean + + +#### round + +boolean + + +#### small + +boolean + + +#### solid + +boolean + + +#### strong + +boolean + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/buttons/readme.md b/packages/core/src/components/buttons/readme.md new file mode 100644 index 0000000000..b8f69ea767 --- /dev/null +++ b/packages/core/src/components/buttons/readme.md @@ -0,0 +1,11 @@ +# ion-buttons + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/card-content/readme.md b/packages/core/src/components/card-content/readme.md new file mode 100644 index 0000000000..cfd2c3b1ce --- /dev/null +++ b/packages/core/src/components/card-content/readme.md @@ -0,0 +1,35 @@ +# ion-card-content + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/card-header/readme.md b/packages/core/src/components/card-header/readme.md new file mode 100644 index 0000000000..a8da58c0ec --- /dev/null +++ b/packages/core/src/components/card-header/readme.md @@ -0,0 +1,35 @@ +# ion-card-header + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/card-subtitle/readme.md b/packages/core/src/components/card-subtitle/readme.md new file mode 100644 index 0000000000..e47a6232fd --- /dev/null +++ b/packages/core/src/components/card-subtitle/readme.md @@ -0,0 +1,35 @@ +# ion-card-subtitle + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/card-title/readme.md b/packages/core/src/components/card-title/readme.md new file mode 100644 index 0000000000..4a6d24cb2e --- /dev/null +++ b/packages/core/src/components/card-title/readme.md @@ -0,0 +1,35 @@ +# ion-card-title + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/card/readme.md b/packages/core/src/components/card/readme.md new file mode 100644 index 0000000000..22ffc44334 --- /dev/null +++ b/packages/core/src/components/card/readme.md @@ -0,0 +1,35 @@ +# ion-card + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/checkbox/readme.md b/packages/core/src/components/checkbox/readme.md new file mode 100644 index 0000000000..dd6ecfd87d --- /dev/null +++ b/packages/core/src/components/checkbox/readme.md @@ -0,0 +1,79 @@ +# ion-checkbox + + + + + + +## Properties + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Attributes + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Events + +#### ionBlur + + +#### ionChange + + +#### ionFocus + + +#### ionStyle + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/chip-button/readme.md b/packages/core/src/components/chip-button/readme.md new file mode 100644 index 0000000000..a1301af677 --- /dev/null +++ b/packages/core/src/components/chip-button/readme.md @@ -0,0 +1,65 @@ +# ion-chip-button + + + + + + +## Properties + +#### clear + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### href + +string + + +#### mode + +any + + +## Attributes + +#### clear + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### href + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/chip/readme.md b/packages/core/src/components/chip/readme.md new file mode 100644 index 0000000000..ee4c1ddbf4 --- /dev/null +++ b/packages/core/src/components/chip/readme.md @@ -0,0 +1,35 @@ +# ion-chip + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/content/readme.md b/packages/core/src/components/content/readme.md new file mode 100644 index 0000000000..60519bbb11 --- /dev/null +++ b/packages/core/src/components/content/readme.md @@ -0,0 +1,66 @@ +# ion-content + + + + + + +## Properties + +#### fullscreen + +boolean + + +#### ionScroll + +any + + +#### ionScrollEnd + +any + + +#### ionScrollStart + +any + + +## Attributes + +#### fullscreen + +boolean + + +#### ionScroll + +any + + +#### ionScrollEnd + +any + + +#### ionScrollStart + +any + + +## Methods + +#### enableJsScroll() + + +#### scrollToBottom() + + +#### scrollToTop() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/datetime/readme.md b/packages/core/src/components/datetime/readme.md new file mode 100644 index 0000000000..f80d1654a9 --- /dev/null +++ b/packages/core/src/components/datetime/readme.md @@ -0,0 +1,210 @@ +# ion-datetime + + + + + + +## Properties + +#### cancelText + +string + + +#### dayNames + +any + + +#### dayShortNames + +any + + +#### dayValues + +any + + +#### disabled + +boolean + + +#### displayFormat + +string + + +#### doneText + +string + + +#### hourValues + +any + + +#### max + +string + + +#### min + +string + + +#### minuteValues + +any + + +#### monthNames + +any + + +#### monthShortNames + +any + + +#### monthValues + +any + + +#### pickerFormat + +string + + +#### pickerOptions + +any + + +#### placeholder + +string + + +#### value + +string + + +#### yearValues + +any + + +## Attributes + +#### cancelText + +string + + +#### dayNames + +any + + +#### dayShortNames + +any + + +#### dayValues + +any + + +#### disabled + +boolean + + +#### displayFormat + +string + + +#### doneText + +string + + +#### hourValues + +any + + +#### max + +string + + +#### min + +string + + +#### minuteValues + +any + + +#### monthNames + +any + + +#### monthShortNames + +any + + +#### monthValues + +any + + +#### pickerFormat + +string + + +#### pickerOptions + +any + + +#### placeholder + +string + + +#### value + +string + + +#### yearValues + +any + + +## Events + +#### ionCancel + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/fab/readme.md b/packages/core/src/components/fab/readme.md new file mode 100644 index 0000000000..dd0a9b1d06 --- /dev/null +++ b/packages/core/src/components/fab/readme.md @@ -0,0 +1,16 @@ +# ion-fab + + + + + + +## Methods + +#### close() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/footer/readme.md b/packages/core/src/components/footer/readme.md new file mode 100644 index 0000000000..368f01df55 --- /dev/null +++ b/packages/core/src/components/footer/readme.md @@ -0,0 +1,11 @@ +# ion-footer + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/gesture-controller/readme.md b/packages/core/src/components/gesture-controller/readme.md new file mode 100644 index 0000000000..947addcc38 --- /dev/null +++ b/packages/core/src/components/gesture-controller/readme.md @@ -0,0 +1,11 @@ +# ion-gesture-controller + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/gesture/readme.md b/packages/core/src/components/gesture/readme.md new file mode 100644 index 0000000000..ed4569ea2d --- /dev/null +++ b/packages/core/src/components/gesture/readme.md @@ -0,0 +1,212 @@ +# ion-gesture + + + + + + +## Properties + +#### attachTo + +any + + +#### autoBlockAll + +boolean + + +#### block + +string + + +#### canStart + +any + + +#### direction + +string + + +#### disableScroll + +boolean + + +#### enabled + +boolean + + +#### gestureName + +string + + +#### gesturePriority + +number + + +#### maxAngle + +number + + +#### notCaptured + +any + + +#### onEnd + +any + + +#### onMove + +any + + +#### onPress + +any + + +#### onStart + +any + + +#### onWillStart + +any + + +#### threshold + +number + + +#### type + +string + + +## Attributes + +#### attachTo + +any + + +#### autoBlockAll + +boolean + + +#### block + +string + + +#### canStart + +any + + +#### direction + +string + + +#### disableScroll + +boolean + + +#### enabled + +boolean + + +#### gestureName + +string + + +#### gesturePriority + +number + + +#### maxAngle + +number + + +#### notCaptured + +any + + +#### onEnd + +any + + +#### onMove + +any + + +#### onPress + +any + + +#### onStart + +any + + +#### onWillStart + +any + + +#### threshold + +number + + +#### type + +string + + +## Events + +#### ionGestureEnd + + +#### ionGestureMove + + +#### ionGestureNotCaptured + + +#### ionGestureStart + + +#### ionPress + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/grid/readme.md b/packages/core/src/components/grid/readme.md new file mode 100644 index 0000000000..5286635663 --- /dev/null +++ b/packages/core/src/components/grid/readme.md @@ -0,0 +1,11 @@ +# ion-col + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/header/readme.md b/packages/core/src/components/header/readme.md new file mode 100644 index 0000000000..cf6ef2fbe6 --- /dev/null +++ b/packages/core/src/components/header/readme.md @@ -0,0 +1,11 @@ +# ion-header + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/infinite-scroll/readme.md b/packages/core/src/components/infinite-scroll/readme.md new file mode 100644 index 0000000000..445820d4e2 --- /dev/null +++ b/packages/core/src/components/infinite-scroll/readme.md @@ -0,0 +1,35 @@ +# ion-infinite-scroll-content + + + + + + +## Properties + +#### loadingSpinner + +string + + +#### loadingText + +string + + +## Attributes + +#### loadingSpinner + +string + + +#### loadingText + +string + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/input/readme.md b/packages/core/src/components/input/readme.md new file mode 100644 index 0000000000..0b411eafe0 --- /dev/null +++ b/packages/core/src/components/input/readme.md @@ -0,0 +1,286 @@ +# ion-input + + + + + + +## Properties + +#### accept + +string + + +#### autocapitalize + +string + + +#### autocomplete + +string + + +#### autocorrect + +string + + +#### autofocus + +boolean + + +#### checked + +boolean + + +#### clearInput + +boolean + + +#### clearOnEdit + +boolean + + +#### disabled + +boolean + + +#### inputmode + +string + + +#### max + +string + + +#### maxlength + +number + + +#### min + +string + + +#### minlength + +number + + +#### multiple + +boolean + + +#### name + +string + + +#### pattern + +string + + +#### placeholder + +string + + +#### readonly + +boolean + + +#### required + +boolean + + +#### results + +number + + +#### size + +number + + +#### spellcheck + +boolean + + +#### step + +string + + +#### type + +string + + +#### value + +string + + +## Attributes + +#### accept + +string + + +#### autocapitalize + +string + + +#### autocomplete + +string + + +#### autocorrect + +string + + +#### autofocus + +boolean + + +#### checked + +boolean + + +#### clearInput + +boolean + + +#### clearOnEdit + +boolean + + +#### disabled + +boolean + + +#### inputmode + +string + + +#### max + +string + + +#### maxlength + +number + + +#### min + +string + + +#### minlength + +number + + +#### multiple + +boolean + + +#### name + +string + + +#### pattern + +string + + +#### placeholder + +string + + +#### readonly + +boolean + + +#### required + +boolean + + +#### results + +number + + +#### size + +number + + +#### spellcheck + +boolean + + +#### step + +string + + +#### type + +string + + +#### value + +string + + +## Events + +#### ionBlur + + +#### ionFocus + + +#### ionStyle + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/item-divider/readme.md b/packages/core/src/components/item-divider/readme.md new file mode 100644 index 0000000000..7f6e01d4aa --- /dev/null +++ b/packages/core/src/components/item-divider/readme.md @@ -0,0 +1,35 @@ +# ion-item-divider + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/item-sliding/readme.md b/packages/core/src/components/item-sliding/readme.md new file mode 100644 index 0000000000..e50de5cbd5 --- /dev/null +++ b/packages/core/src/components/item-sliding/readme.md @@ -0,0 +1,55 @@ +# ion-item-option + + + + + + +## Properties + +#### color + +string + + +#### disabled + +boolean + + +#### href + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### disabled + +boolean + + +#### href + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/item/readme.md b/packages/core/src/components/item/readme.md new file mode 100644 index 0000000000..2cc64c13a8 --- /dev/null +++ b/packages/core/src/components/item/readme.md @@ -0,0 +1,45 @@ +# ion-item + + + + + + +## Properties + +#### color + +string + + +#### href + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### href + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/keyboard-controller/readme.md b/packages/core/src/components/keyboard-controller/readme.md new file mode 100644 index 0000000000..0d94147188 --- /dev/null +++ b/packages/core/src/components/keyboard-controller/readme.md @@ -0,0 +1,25 @@ +# ion-keyboard-controller + + + + + + +## Events + +#### keyboardDidHide + + +#### keyboardDidShow + + +#### keyboardWillHide + + +#### keyboardWillShow + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/label/readme.md b/packages/core/src/components/label/readme.md new file mode 100644 index 0000000000..fe2d030e32 --- /dev/null +++ b/packages/core/src/components/label/readme.md @@ -0,0 +1,75 @@ +# ion-label + + + + + + +## Properties + +#### color + +string + + +#### fixed + +boolean + + +#### floating + +boolean + + +#### mode + +any + + +#### stacked + +boolean + + +## Attributes + +#### color + +string + + +#### fixed + +boolean + + +#### floating + +boolean + + +#### mode + +any + + +#### stacked + +boolean + + +## Events + +#### ionStyle + + +## Methods + +#### getText() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/list-header/readme.md b/packages/core/src/components/list-header/readme.md new file mode 100644 index 0000000000..24ac09a37a --- /dev/null +++ b/packages/core/src/components/list-header/readme.md @@ -0,0 +1,35 @@ +# ion-list-header + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/list/readme.md b/packages/core/src/components/list/readme.md new file mode 100644 index 0000000000..7fb04c505f --- /dev/null +++ b/packages/core/src/components/list/readme.md @@ -0,0 +1,22 @@ +# ion-list + + + + + + +## Methods + +#### closeSlidingItems() + + +#### getOpenedItem() + + +#### setOpenedItem() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/loading-controller/readme.md b/packages/core/src/components/loading-controller/readme.md new file mode 100644 index 0000000000..164b898e4a --- /dev/null +++ b/packages/core/src/components/loading-controller/readme.md @@ -0,0 +1,16 @@ +# ion-loading-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/loading/readme.md b/packages/core/src/components/loading/readme.md new file mode 100644 index 0000000000..b094292af7 --- /dev/null +++ b/packages/core/src/components/loading/readme.md @@ -0,0 +1,115 @@ +# ion-loading + + + + + + +## Properties + +#### content + +string + + +#### cssClass + +string + + +#### dismissOnPageChange + +boolean + + +#### duration + +number + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### loadingId + +string + + +#### showBackdrop + +boolean + + +## Attributes + +#### content + +string + + +#### cssClass + +string + + +#### dismissOnPageChange + +boolean + + +#### duration + +number + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### loadingId + +string + + +#### showBackdrop + +boolean + + +## Events + +#### ionLoadingDidDismiss + + +#### ionLoadingDidLoad + + +#### ionLoadingDidPresent + + +#### ionLoadingDidUnload + + +#### ionLoadingWillDismiss + + +#### ionLoadingWillPresent + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/menu-controller/readme.md b/packages/core/src/components/menu-controller/readme.md new file mode 100644 index 0000000000..4d6ae9a6eb --- /dev/null +++ b/packages/core/src/components/menu-controller/readme.md @@ -0,0 +1,58 @@ +# ion-menu-controller + + + + + + +## Methods + +#### _register() + + +#### _setActiveMenu() + + +#### _unregister() + + +#### close() + + +#### createAnimation() + + +#### enable() + + +#### get() + + +#### getMenus() + + +#### getOpen() + + +#### isAnimating() + + +#### isEnabled() + + +#### isOpen() + + +#### open() + + +#### swipeEnable() + + +#### toggle() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/menu/readme.md b/packages/core/src/components/menu/readme.md new file mode 100644 index 0000000000..376d796be1 --- /dev/null +++ b/packages/core/src/components/menu/readme.md @@ -0,0 +1,123 @@ +# ion-menu + + + + + + +## Properties + +#### content + +string + + +#### enabled + +boolean + + +#### maxEdgeStart + +number + + +#### menuId + +string + + +#### persistent + +boolean + + +#### side + +any + + +#### swipeEnabled + +boolean + + +#### type + +string + + +## Attributes + +#### content + +string + + +#### enabled + +boolean + + +#### maxEdgeStart + +number + + +#### menuId + +string + + +#### persistent + +boolean + + +#### side + +any + + +#### swipeEnabled + +boolean + + +#### type + +string + + +## Events + +#### ionClose + + +#### ionDrag + + +#### ionOpen + + +## Methods + +#### close() + + +#### isOpen() + + +#### open() + + +#### setOpen() + + +#### toggle() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/modal-controller/readme.md b/packages/core/src/components/modal-controller/readme.md new file mode 100644 index 0000000000..8e0221f230 --- /dev/null +++ b/packages/core/src/components/modal-controller/readme.md @@ -0,0 +1,16 @@ +# ion-modal-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/modal/readme.md b/packages/core/src/components/modal/readme.md new file mode 100644 index 0000000000..23c145cbae --- /dev/null +++ b/packages/core/src/components/modal/readme.md @@ -0,0 +1,135 @@ +# ion-modal + + + + + + +## Properties + +#### color + +string + + +#### component + +string + + +#### componentProps + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### modalId + +string + + +#### mode + +string + + +#### showBackdrop + +boolean + + +## Attributes + +#### color + +string + + +#### component + +string + + +#### componentProps + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### modalId + +string + + +#### mode + +string + + +#### showBackdrop + +boolean + + +## Events + +#### ionModalDidDismiss + + +#### ionModalDidLoad + + +#### ionModalDidPresent + + +#### ionModalDidUnload + + +#### ionModalWillDismiss + + +#### ionModalWillPresent + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/nav-controller/readme.md b/packages/core/src/components/nav-controller/readme.md new file mode 100644 index 0000000000..c96276aa78 --- /dev/null +++ b/packages/core/src/components/nav-controller/readme.md @@ -0,0 +1,57 @@ +# ion-nav-controller + + + + + + +## Properties + +#### delegate + +any + + +## Attributes + +#### delegate + +any + + +## Methods + +#### insert() + + +#### insertPages() + + +#### pop() + + +#### popTo() + + +#### popToRoot() + + +#### push() + + +#### removeIndex() + + +#### removeView() + + +#### setPages() + + +#### setRoot() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/nav/readme.md b/packages/core/src/components/nav/readme.md new file mode 100644 index 0000000000..823ff6c2ea --- /dev/null +++ b/packages/core/src/components/nav/readme.md @@ -0,0 +1,118 @@ +# ion-nav + + + + + + +## Properties + +#### delegate + +any + + +#### mode + +string + + +#### root + +any + + +## Attributes + +#### delegate + +any + + +#### mode + +string + + +#### root + +any + + +## Events + +#### ionNavChanged + + +#### navInit + + +## Methods + +#### addRoute() + + +#### canGoBack() + + +#### canSwipeBack() + + +#### getActive() + + +#### getFirstView() + + +#### getPrevious() + + +#### getRoutes() + + +#### getState() + + +#### insert() + + +#### insertPages() + + +#### pop() + + +#### popTo() + + +#### popToRoot() + + +#### push() + + +#### removeIndex() + + +#### removeRoute() + + +#### removeView() + + +#### resize() + + +#### setPages() + + +#### setRoot() + + +#### setRouteId() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/note/readme.md b/packages/core/src/components/note/readme.md new file mode 100644 index 0000000000..50ebfe1637 --- /dev/null +++ b/packages/core/src/components/note/readme.md @@ -0,0 +1,35 @@ +# ion-note + + + + + + +## Properties + +#### color + +string + + +#### mode + +any + + +## Attributes + +#### color + +string + + +#### mode + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/page/readme.md b/packages/core/src/components/page/readme.md new file mode 100644 index 0000000000..396914ba19 --- /dev/null +++ b/packages/core/src/components/page/readme.md @@ -0,0 +1,11 @@ +# ion-page + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/picker-controller/readme.md b/packages/core/src/components/picker-controller/readme.md new file mode 100644 index 0000000000..8bcf88b620 --- /dev/null +++ b/packages/core/src/components/picker-controller/readme.md @@ -0,0 +1,16 @@ +# ion-picker-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/picker/readme.md b/packages/core/src/components/picker/readme.md new file mode 100644 index 0000000000..686b1e8a36 --- /dev/null +++ b/packages/core/src/components/picker/readme.md @@ -0,0 +1,25 @@ +# ion-picker-column + + + + + + +## Properties + +#### col + +any + + +## Attributes + +#### col + +any + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/popover-controller/readme.md b/packages/core/src/components/popover-controller/readme.md new file mode 100644 index 0000000000..295bacf0cf --- /dev/null +++ b/packages/core/src/components/popover-controller/readme.md @@ -0,0 +1,16 @@ +# ion-popover-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/popover/readme.md b/packages/core/src/components/popover/readme.md new file mode 100644 index 0000000000..3473246e67 --- /dev/null +++ b/packages/core/src/components/popover/readme.md @@ -0,0 +1,145 @@ +# ion-popover + + + + + + +## Properties + +#### color + +string + + +#### component + +string + + +#### componentProps + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### ev + +any + + +#### exitAnimation + +any + + +#### mode + +string + + +#### popoverId + +string + + +#### showBackdrop + +boolean + + +## Attributes + +#### color + +string + + +#### component + +string + + +#### componentProps + +any + + +#### cssClass + +string + + +#### enableBackdropDismiss + +boolean + + +#### enterAnimation + +any + + +#### ev + +any + + +#### exitAnimation + +any + + +#### mode + +string + + +#### popoverId + +string + + +#### showBackdrop + +boolean + + +## Events + +#### ionPopoverDidDismiss + + +#### ionPopoverDidLoad + + +#### ionPopoverDidPresent + + +#### ionPopoverDidUnload + + +#### ionPopoverWillDismiss + + +#### ionPopoverWillPresent + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/radio-group/readme.md b/packages/core/src/components/radio-group/readme.md index 0ff20b6c91..7fc3508941 100644 --- a/packages/core/src/components/radio-group/readme.md +++ b/packages/core/src/components/radio-group/readme.md @@ -44,3 +44,61 @@ radio button within the same group. ``` + + + + + +## Properties + +#### allowEmptySelection + +boolean + + +#### disabled + +boolean + + +#### name + +string + + +#### value + +string + + +## Attributes + +#### allowEmptySelection + +boolean + + +#### disabled + +boolean + + +#### name + +string + + +#### value + +string + + +## Events + +#### ionChange + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/radio/readme.md b/packages/core/src/components/radio/readme.md index 9b63743a28..7ec6e5e3c5 100644 --- a/packages/core/src/components/radio/readme.md +++ b/packages/core/src/components/radio/readme.md @@ -38,3 +38,96 @@ then they will all have the ability to be checked at the same time. ``` + + + + + +## Properties + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### name + +string + + +#### value + +string + + +## Attributes + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### name + +string + + +#### value + +string + + +## Events + +#### ionBlur + + +#### ionFocus + + +#### ionRadioDidLoad + + +#### ionRadioDidUnload + + +#### ionSelect + + +#### ionStyle + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/range/readme.md b/packages/core/src/components/range/readme.md new file mode 100644 index 0000000000..434a03d3e4 --- /dev/null +++ b/packages/core/src/components/range/readme.md @@ -0,0 +1,113 @@ +# ion-range-knob + + + + + + +## Properties + +#### disabled + +boolean + + +#### knob + +string + + +#### labelId + +string + + +#### max + +number + + +#### min + +number + + +#### pin + +boolean + + +#### pressed + +boolean + + +#### ratio + +number + + +#### val + +number + + +## Attributes + +#### disabled + +boolean + + +#### knob + +string + + +#### labelId + +string + + +#### max + +number + + +#### min + +number + + +#### pin + +boolean + + +#### pressed + +boolean + + +#### ratio + +number + + +#### val + +number + + +## Events + +#### ionDecrease + + +#### ionIncrease + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/reorder/readme.md b/packages/core/src/components/reorder/readme.md new file mode 100644 index 0000000000..0a2dd27deb --- /dev/null +++ b/packages/core/src/components/reorder/readme.md @@ -0,0 +1,11 @@ +# ion-reorder + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/router/readme.md b/packages/core/src/components/router/readme.md new file mode 100644 index 0000000000..74bc577030 --- /dev/null +++ b/packages/core/src/components/router/readme.md @@ -0,0 +1,35 @@ +# ion-route-link + + + + + + +## Properties + +#### router + +any + + +#### url + +string + + +## Attributes + +#### router + +any + + +#### url + +string + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/scroll/readme.md b/packages/core/src/components/scroll/readme.md new file mode 100644 index 0000000000..be2de69604 --- /dev/null +++ b/packages/core/src/components/scroll/readme.md @@ -0,0 +1,87 @@ +# ion-scroll + + + + + + +## Properties + +#### enabled + +boolean + + +#### jsScroll + +boolean + + +#### onionScroll + +any + + +#### onionScrollEnd + +any + + +#### onionScrollStart + +any + + +## Attributes + +#### enabled + +boolean + + +#### jsScroll + +boolean + + +#### onionScroll + +any + + +#### onionScrollEnd + +any + + +#### onionScrollStart + +any + + +## Events + +#### ionScroll + + +#### ionScrollEnd + + +#### ionScrollStart + + +## Methods + +#### scrollToBottom() + + +#### scrollToPoint() + + +#### scrollToTop() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/searchbar/readme.md b/packages/core/src/components/searchbar/readme.md new file mode 100644 index 0000000000..aa196dff5e --- /dev/null +++ b/packages/core/src/components/searchbar/readme.md @@ -0,0 +1,152 @@ +# ion-searchbar + + + + + + +## Properties + +#### animated + +boolean + + +#### autocomplete + +string + + +#### autocorrect + +string + + +#### cancelButtonText + +string + + +#### color + +string + + +#### debounce + +number + + +#### mode + +any + + +#### placeholder + +string + + +#### showCancelButton + +boolean + + +#### spellcheck + +boolean + + +#### type + +string + + +#### value + +string + + +## Attributes + +#### animated + +boolean + + +#### autocomplete + +string + + +#### autocorrect + +string + + +#### cancelButtonText + +string + + +#### color + +string + + +#### debounce + +number + + +#### mode + +any + + +#### placeholder + +string + + +#### showCancelButton + +boolean + + +#### spellcheck + +boolean + + +#### type + +string + + +#### value + +string + + +## Events + +#### ionBlur + + +#### ionCancel + + +#### ionClear + + +#### ionFocus + + +#### ionInput + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/segment-button/readme.md b/packages/core/src/components/segment-button/readme.md new file mode 100644 index 0000000000..0d3b6f67b9 --- /dev/null +++ b/packages/core/src/components/segment-button/readme.md @@ -0,0 +1,70 @@ +# ion-segment-button + + + + + + +## Properties + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Attributes + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Events + +#### ionClick + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/segment/readme.md b/packages/core/src/components/segment/readme.md new file mode 100644 index 0000000000..df77be4afa --- /dev/null +++ b/packages/core/src/components/segment/readme.md @@ -0,0 +1,60 @@ +# ion-segment + + + + + + +## Properties + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Attributes + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Events + +#### ionChange + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/select-option/readme.md b/packages/core/src/components/select-option/readme.md new file mode 100644 index 0000000000..61c22bf16a --- /dev/null +++ b/packages/core/src/components/select-option/readme.md @@ -0,0 +1,55 @@ +# ion-select-option + + + + + + +## Properties + +#### disabled + +boolean + + +#### selected + +boolean + + +#### value + +string + + +## Attributes + +#### disabled + +boolean + + +#### selected + +boolean + + +#### value + +string + + +## Events + +#### ionSelect + + +## Methods + +#### getText() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/select/readme.md b/packages/core/src/components/select/readme.md new file mode 100644 index 0000000000..bc82a4364a --- /dev/null +++ b/packages/core/src/components/select/readme.md @@ -0,0 +1,40 @@ +# ion-select-popover + + + + + + +## Properties + +#### options + +any + + +#### value + +string + + +## Attributes + +#### options + +any + + +#### value + +string + + +## Events + +#### ionDismiss + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/skeleton-text/readme.md b/packages/core/src/components/skeleton-text/readme.md new file mode 100644 index 0000000000..0408afb744 --- /dev/null +++ b/packages/core/src/components/skeleton-text/readme.md @@ -0,0 +1,25 @@ +# ion-skeleton-text + + + + + + +## Properties + +#### width + +string + + +## Attributes + +#### width + +string + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/slides/readme.md b/packages/core/src/components/slides/readme.md new file mode 100644 index 0000000000..b6db5f74cf --- /dev/null +++ b/packages/core/src/components/slides/readme.md @@ -0,0 +1,11 @@ +# ion-slide + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/spinner/readme.md b/packages/core/src/components/spinner/readme.md new file mode 100644 index 0000000000..d819303746 --- /dev/null +++ b/packages/core/src/components/spinner/readme.md @@ -0,0 +1,65 @@ +# ion-spinner + + + + + + +## Properties + +#### color + +string + + +#### duration + +number + + +#### mode + +any + + +#### name + +string + + +#### paused + +boolean + + +## Attributes + +#### color + +string + + +#### duration + +number + + +#### mode + +any + + +#### name + +string + + +#### paused + +boolean + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/split-pane/readme.md b/packages/core/src/components/split-pane/readme.md new file mode 100644 index 0000000000..f10617662c --- /dev/null +++ b/packages/core/src/components/split-pane/readme.md @@ -0,0 +1,48 @@ +# ion-split-pane + + + + + + +## Properties + +#### enabled + +boolean + + +#### when + +any + + +## Attributes + +#### enabled + +boolean + + +#### when + +any + + +## Events + +#### ionChange + + +#### ionSplitPaneDidChange + + +## Methods + +#### isVisible() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/tabs/readme.md b/packages/core/src/components/tabs/readme.md new file mode 100644 index 0000000000..c1343f7d77 --- /dev/null +++ b/packages/core/src/components/tabs/readme.md @@ -0,0 +1,11 @@ +# page-tab + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/thumbnail/readme.md b/packages/core/src/components/thumbnail/readme.md new file mode 100644 index 0000000000..0780e2873c --- /dev/null +++ b/packages/core/src/components/thumbnail/readme.md @@ -0,0 +1,11 @@ +# ion-thumbnail + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/title/readme.md b/packages/core/src/components/title/readme.md new file mode 100644 index 0000000000..19c0581ff9 --- /dev/null +++ b/packages/core/src/components/title/readme.md @@ -0,0 +1,11 @@ +# ion-title + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/toast-controller/readme.md b/packages/core/src/components/toast-controller/readme.md new file mode 100644 index 0000000000..d3e02c062a --- /dev/null +++ b/packages/core/src/components/toast-controller/readme.md @@ -0,0 +1,16 @@ +# ion-toast-controller + + + + + + +## Methods + +#### create() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/toast/readme.md b/packages/core/src/components/toast/readme.md new file mode 100644 index 0000000000..6fbf75a03f --- /dev/null +++ b/packages/core/src/components/toast/readme.md @@ -0,0 +1,135 @@ +# ion-toast + + + + + + +## Properties + +#### closeButtonText + +string + + +#### cssClass + +string + + +#### dismissOnPageChange + +boolean + + +#### duration + +number + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### message + +string + + +#### position + +string + + +#### showCloseButton + +boolean + + +#### toastId + +string + + +## Attributes + +#### closeButtonText + +string + + +#### cssClass + +string + + +#### dismissOnPageChange + +boolean + + +#### duration + +number + + +#### enterAnimation + +any + + +#### exitAnimation + +any + + +#### message + +string + + +#### position + +string + + +#### showCloseButton + +boolean + + +#### toastId + +string + + +## Events + +#### ionToastDidDismiss + + +#### ionToastDidLoad + + +#### ionToastDidPresent + + +#### ionToastDidUnload + + +#### ionToastWillDismiss + + +#### ionToastWillPresent + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/toggle/readme.md b/packages/core/src/components/toggle/readme.md new file mode 100644 index 0000000000..9f1406cf79 --- /dev/null +++ b/packages/core/src/components/toggle/readme.md @@ -0,0 +1,84 @@ +# ion-toggle + + + + + + +## Properties + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Attributes + +#### checked + +boolean + + +#### color + +string + + +#### disabled + +boolean + + +#### mode + +any + + +#### value + +string + + +## Events + +#### ionBlur + + +#### ionChange + + +#### ionFocus + + +#### ionStyle + + +## Methods + +#### toggle() + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/toolbar/readme.md b/packages/core/src/components/toolbar/readme.md new file mode 100644 index 0000000000..8dea652414 --- /dev/null +++ b/packages/core/src/components/toolbar/readme.md @@ -0,0 +1,55 @@ +# ion-navbar + + + + + + +## Properties + +#### backButtonIcon + +string + + +#### backButtonText + +string + + +#### hidden + +boolean + + +#### hideBackButton + +boolean + + +## Attributes + +#### backButtonIcon + +string + + +#### backButtonText + +string + + +#### hidden + +boolean + + +#### hideBackButton + +boolean + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)* diff --git a/packages/core/src/components/util/readme.md b/packages/core/src/components/util/readme.md new file mode 100644 index 0000000000..b9013072a0 --- /dev/null +++ b/packages/core/src/components/util/readme.md @@ -0,0 +1,11 @@ +# ion-utils + + + + + + + +---------------------------------------------- + +*Built by [StencilJS](https://stenciljs.com/)*