diff --git a/packages/core/package-lock.json b/packages/core/package-lock.json index 7648dce751..f96b54b753 100644 --- a/packages/core/package-lock.json +++ b/packages/core/package-lock.json @@ -14,9 +14,9 @@ } }, "@stencil/core": { - "version": "0.0.9-1", - "resolved": "https://registry.npmjs.org/@stencil/core/-/core-0.0.9-1.tgz", - "integrity": "sha512-kCcLfolV2QMVu4iAzIBxiJ9L90jaLRZRvR8ureuDVoAjBQ+VSk7jS3kMGMjnPEHk8ctamj60tGvlkEzYbSmpkg==", + "version": "0.0.9-2", + "resolved": "https://registry.npmjs.org/@stencil/core/-/core-0.0.9-2.tgz", + "integrity": "sha512-IxG/6XGtV+2NpNmg5kjtGiYw2ZW39ZEQoST3xVzHQjpo63QbdHMd0DJ3T+J3Cionk3fvBtzoFh8Pv14+PZlTIw==", "dev": true, "requires": { "chokidar": "1.7.0", @@ -3428,9 +3428,9 @@ "dev": true }, "ionicons": { - "version": "4.0.0-9", - "resolved": "https://registry.npmjs.org/ionicons/-/ionicons-4.0.0-9.tgz", - "integrity": "sha512-9hIph66tEEU0EVJi/VhlRzY4S8NrnINM5KZ5hUU/CWmx5jSJKZctf3dtkmZS1QiiyXIBwpMm6IlQCMPZCX/41A==", + "version": "4.0.0-10", + "resolved": "https://registry.npmjs.org/ionicons/-/ionicons-4.0.0-10.tgz", + "integrity": "sha512-Ucr/nsio5YEIawva/Wcdu8zIJX/rs2otf7LiXmGgME09aE4N3id35fAko0LloTNpSxg0Lw0oX/KJEAI4prqVvA==", "dev": true }, "is-arrayish": { diff --git a/packages/core/package.json b/packages/core/package.json index 38b0e2282d..2695a89ead 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -10,12 +10,12 @@ "dist/" ], "devDependencies": { - "@stencil/core": "0.0.9-1", + "@stencil/core": "0.0.9-2", "@stencil/dev-server": "0.0.18-0", "@stencil/utils": "latest", "@types/jest": "^21.1.6", "chromedriver": "^2.33.2", - "ionicons": "4.0.0-9", + "ionicons": "4.0.0-10", "jest": "^21.2.1", "mocha": "^4.0.1", "np": "^2.17.0", diff --git a/packages/core/src/components.d.ts b/packages/core/src/components.d.ts index 97617242f5..0137e730f4 100644 --- a/packages/core/src/components.d.ts +++ b/packages/core/src/components.d.ts @@ -11,9 +11,9 @@ import { } from './components/action-sheet/action-sheet'; import { AnimationBuilder, - PickerOptions, FrameworkDelegate, PickerColumn, + PickerOptions, } from './index'; import { AlertButton, @@ -95,15 +95,15 @@ declare global { } namespace JSXElements { export interface IonActionSheetAttributes extends HTMLAttributes { - cssClass?: string; - title?: string; - subTitle?: string; - buttons?: ActionSheetButton[]; - enableBackdropDismiss?: boolean; - translucent?: boolean; animate?: boolean; + buttons?: ActionSheetButton[]; + cssClass?: string; + enableBackdropDismiss?: boolean; enterAnimation?: AnimationBuilder; leaveAnimation?: AnimationBuilder; + subTitle?: string; + title?: string; + translucent?: boolean; } } } @@ -163,17 +163,17 @@ declare global { } namespace JSXElements { export interface IonAlertAttributes extends HTMLAttributes { - cssClass?: string; - title?: string; - subTitle?: string; - message?: string; - buttons?: AlertButton[]; - inputs?: AlertInput[]; - enableBackdropDismiss?: boolean; - translucent?: boolean; animate?: boolean; + buttons?: AlertButton[]; + cssClass?: string; + enableBackdropDismiss?: boolean; enterAnimation?: AnimationBuilder; + inputs?: AlertInput[]; leaveAnimation?: AnimationBuilder; + message?: string; + subTitle?: string; + title?: string; + translucent?: boolean; } } } @@ -354,16 +354,16 @@ declare global { } namespace JSXElements { export interface IonButtonAttributes extends HTMLAttributes { - href?: string; buttonType?: string; - size?: 'small' | 'default' | 'large'; - disabled?: boolean; - fill?: 'clear' | 'outline' | 'solid' | 'default'; - round?: boolean; - expand?: 'full' | 'block'; - strong?: boolean; color?: string; + disabled?: boolean; + expand?: 'full' | 'block'; + fill?: 'clear' | 'outline' | 'solid' | 'default'; + href?: string; mode?: 'ios' | 'md'; + round?: boolean; + size?: 'small' | 'default' | 'large'; + strong?: boolean; } } } @@ -579,11 +579,11 @@ declare global { } namespace JSXElements { export interface IonCheckboxAttributes extends HTMLAttributes { + checked?: boolean; color?: string; + disabled?: boolean; mode?: 'ios' | 'md'; name?: string; - checked?: boolean; - disabled?: boolean; value?: string; } } @@ -614,11 +614,11 @@ declare global { } namespace JSXElements { export interface IonChipButtonAttributes extends HTMLAttributes { - href?: string; - color?: string; - mode?: 'ios' | 'md'; clear?: boolean; + color?: string; disabled?: boolean; + href?: string; + mode?: 'ios' | 'md'; } } } @@ -709,10 +709,10 @@ declare global { } namespace JSXElements { export interface IonContentAttributes extends HTMLAttributes { - ionScrollStart?: Function; + fullscreen?: boolean; ionScroll?: Function; ionScrollEnd?: Function; - fullscreen?: boolean; + ionScrollStart?: Function; } } } @@ -742,25 +742,25 @@ declare global { } namespace JSXElements { export interface IonDatetimeAttributes extends HTMLAttributes { - disabled?: boolean; - min?: string; - max?: string; - displayFormat?: string; - pickerFormat?: string; cancelText?: string; - doneText?: string; - yearValues?: any; - monthValues?: any; + dayNames?: any; + dayShortNames?: any; dayValues?: any; + disabled?: boolean; + displayFormat?: string; + doneText?: string; hourValues?: any; + max?: string; + min?: string; minuteValues?: any; monthNames?: any; monthShortNames?: any; - dayNames?: any; - dayShortNames?: any; + monthValues?: any; + pickerFormat?: string; pickerOptions?: PickerOptions; placeholder?: string; value?: string; + yearValues?: any; } } } @@ -790,14 +790,14 @@ declare global { } namespace JSXElements { export interface IonFabButtonAttributes extends HTMLAttributes { - color?: string; - mode?: 'ios' | 'md'; - href?: string; - translucent?: boolean; activated?: boolean; - toggleActive?: Function; - show?: boolean; + color?: string; disabled?: boolean; + href?: string; + mode?: 'ios' | 'md'; + show?: boolean; + toggleActive?: Function; + translucent?: boolean; } } } @@ -947,24 +947,24 @@ declare global { } namespace JSXElements { export interface IonGestureAttributes extends HTMLAttributes { - enabled?: boolean; attachTo?: ElementRef; autoBlockAll?: boolean; block?: string; - disableScroll?: boolean; + canStart?: GestureCallback; direction?: string; + disableScroll?: boolean; + enabled?: boolean; gestureName?: string; gesturePriority?: number; maxAngle?: number; + notCaptured?: GestureCallback; + onEnd?: GestureCallback; + onMove?: GestureCallback; + onPress?: GestureCallback; + onStart?: GestureCallback; + onWillStart?: (_: GestureDetail) => Promise; threshold?: number; type?: string; - canStart?: GestureCallback; - onWillStart?: (_: GestureDetail) => Promise; - onStart?: GestureCallback; - onMove?: GestureCallback; - onEnd?: GestureCallback; - onPress?: GestureCallback; - notCaptured?: GestureCallback; } } } @@ -1085,9 +1085,9 @@ declare global { } namespace JSXElements { export interface IonInfiniteScrollAttributes extends HTMLAttributes { - threshold?: string; enabled?: boolean; position?: string; + threshold?: string; } } } @@ -1138,9 +1138,9 @@ declare global { readonly?: boolean; required?: boolean; results?: number; + size?: number; spellcheck?: boolean; step?: string; - size?: number; type?: string; value?: string; } @@ -1204,9 +1204,9 @@ declare global { namespace JSXElements { export interface IonItemOptionAttributes extends HTMLAttributes { color?: string; - mode?: 'ios' | 'md'; - href?: string; disabled?: boolean; + href?: string; + mode?: 'ios' | 'md'; } } } @@ -1297,8 +1297,8 @@ declare global { namespace JSXElements { export interface IonItemAttributes extends HTMLAttributes { color?: string; - mode?: 'ios' | 'md'; href?: string; + mode?: 'ios' | 'md'; } } } @@ -1359,9 +1359,9 @@ declare global { namespace JSXElements { export interface IonLabelAttributes extends HTMLAttributes { color?: string; - mode?: 'ios' | 'md'; fixed?: boolean; floating?: boolean; + mode?: 'ios' | 'md'; stacked?: boolean; } } @@ -1483,16 +1483,16 @@ declare global { } namespace JSXElements { export interface IonLoadingAttributes extends HTMLAttributes { - spinner?: string; - cssClass?: string; + animate?: boolean; content?: string; + cssClass?: string; dismissOnPageChange?: boolean; duration?: number; - translucent?: boolean; - showBackdrop?: boolean; enterAnimation?: AnimationBuilder; leaveAnimation?: AnimationBuilder; - animate?: boolean; + showBackdrop?: boolean; + spinner?: string; + translucent?: boolean; } } } @@ -1553,13 +1553,13 @@ declare global { namespace JSXElements { export interface IonMenuAttributes extends HTMLAttributes { content?: string; - menuId?: string; - type?: string; enabled?: boolean; + maxEdgeStart?: number; + menuId?: string; + persistent?: boolean; side?: Side; swipeEnabled?: boolean; - persistent?: boolean; - maxEdgeStart?: number; + type?: string; } } } @@ -1619,18 +1619,18 @@ declare global { } namespace JSXElements { export interface IonModalAttributes extends HTMLAttributes { - mode?: string; + animate?: boolean; color?: string; component?: any; - data?: any; cssClass?: string; + data?: any; + delegate?: FrameworkDelegate; enableBackdropDismiss?: boolean; - modalId?: string; - showBackdrop?: boolean; enterAnimation?: AnimationBuilder; leaveAnimation?: AnimationBuilder; - animate?: boolean; - delegate?: FrameworkDelegate; + modalId?: string; + mode?: string; + showBackdrop?: boolean; } } } @@ -1660,9 +1660,9 @@ declare global { } namespace JSXElements { export interface IonNavAttributes extends HTMLAttributes { + delegate?: FrameworkDelegate; mode?: string; root?: any; - delegate?: FrameworkDelegate; } } } @@ -1692,10 +1692,10 @@ declare global { } namespace JSXElements { export interface IonNavbarAttributes extends HTMLAttributes { - hideBackButton?: boolean; - backButtonText?: string; backButtonIcon?: string; + backButtonText?: string; hidden?: boolean; + hideBackButton?: boolean; } } } @@ -1846,18 +1846,18 @@ declare global { } namespace JSXElements { export interface IonPickerAttributes extends HTMLAttributes { - cssClass?: string; + animate?: boolean; + buttons?: PickerButton[]; + columns?: PickerColumn[]; content?: string; + cssClass?: string; dismissOnPageChange?: boolean; duration?: number; + enableBackdropDismiss?: boolean; enterAnimation?: AnimationBuilder; leaveAnimation?: AnimationBuilder; pickerId?: string; showBackdrop?: boolean; - enableBackdropDismiss?: boolean; - animate?: boolean; - buttons?: PickerButton[]; - columns?: PickerColumn[]; } } } @@ -1917,20 +1917,20 @@ declare global { } namespace JSXElements { export interface IonPopoverAttributes extends HTMLAttributes { - mode?: string; + animate?: boolean; color?: string; component?: string; - data?: any; cssClass?: string; + data?: any; + delegate?: FrameworkDelegate; enableBackdropDismiss?: boolean; enterAnimation?: AnimationBuilder; - leaveAnimation?: AnimationBuilder; ev?: Event; + leaveAnimation?: AnimationBuilder; + mode?: string; popoverId?: string; showBackdrop?: boolean; translucent?: boolean; - animate?: boolean; - delegate?: FrameworkDelegate; } } } @@ -1993,11 +1993,11 @@ declare global { } namespace JSXElements { export interface IonRadioAttributes extends HTMLAttributes { + checked?: boolean; color?: string; + disabled?: boolean; mode?: 'ios' | 'md'; name?: string; - disabled?: boolean; - checked?: boolean; value?: string; } } @@ -2028,15 +2028,15 @@ declare global { } namespace JSXElements { export interface IonRangeKnobAttributes extends HTMLAttributes { - pressed?: boolean; - pin?: boolean; - min?: number; - max?: number; - val?: number; disabled?: boolean; - labelId?: string; knob?: string; + labelId?: string; + max?: number; + min?: number; + pin?: boolean; + pressed?: boolean; ratio?: number; + val?: number; } } } @@ -2067,12 +2067,12 @@ declare global { namespace JSXElements { export interface IonRangeAttributes extends HTMLAttributes { color?: string; - mode?: 'ios' | 'md'; debounce?: number; disabled?: boolean; dualKnobs?: boolean; max?: number; min?: number; + mode?: 'ios' | 'md'; pin?: boolean; snaps?: boolean; step?: number; @@ -2166,8 +2166,8 @@ declare global { } namespace JSXElements { export interface IonRouteLinkAttributes extends HTMLAttributes { - url?: string; router?: any; + url?: string; } } } @@ -2197,8 +2197,8 @@ declare global { } namespace JSXElements { export interface IonRouteAttributes extends HTMLAttributes { - path?: string; component?: string; + path?: string; props?: any; } } @@ -2291,9 +2291,9 @@ declare global { export interface IonScrollAttributes extends HTMLAttributes { enabled?: boolean; jsScroll?: boolean; - onionScrollStart?: ScrollCallback; onionScroll?: ScrollCallback; onionScrollEnd?: ScrollCallback; + onionScrollStart?: ScrollCallback; } } } @@ -2323,13 +2323,13 @@ declare global { } namespace JSXElements { export interface IonSearchbarAttributes extends HTMLAttributes { - color?: string; - mode?: 'ios' | 'md'; animated?: boolean; autocomplete?: string; autocorrect?: string; cancelButtonText?: string; + color?: string; debounce?: number; + mode?: 'ios' | 'md'; placeholder?: string; showCancelButton?: boolean; spellcheck?: boolean; @@ -2364,10 +2364,10 @@ declare global { } namespace JSXElements { export interface IonSegmentButtonAttributes extends HTMLAttributes { - color?: string; - mode?: 'ios' | 'md'; checked?: boolean; + color?: string; disabled?: boolean; + mode?: 'ios' | 'md'; value?: string; } } @@ -2399,8 +2399,8 @@ declare global { namespace JSXElements { export interface IonSegmentAttributes extends HTMLAttributes { color?: string; - mode?: 'ios' | 'md'; disabled?: boolean; + mode?: 'ios' | 'md'; value?: string; } } @@ -2493,15 +2493,15 @@ declare global { } namespace JSXElements { export interface IonSelectAttributes extends HTMLAttributes { - disabled?: boolean; cancelText?: string; - okText?: string; - placeholder?: string; - name?: string; - selectedText?: string; - multiple?: boolean; + disabled?: boolean; interface?: string; interfaceOptions?: any; + multiple?: boolean; + name?: string; + okText?: string; + placeholder?: string; + selectedText?: string; value?: string | string[]; } } @@ -2592,11 +2592,12 @@ declare global { } namespace JSXElements { export interface IonSlidesAttributes extends HTMLAttributes { - effect?: string; autoplay?: number; control?: any; direction?: 'horizontal' | 'vertical'; + effect?: string; initialSlide?: number; + keyboardControl?: boolean; loop?: boolean; pager?: boolean; paginationType?: string; @@ -2605,7 +2606,6 @@ declare global { spaceBetween?: number; speed?: number; zoom?: boolean; - keyboardControl?: boolean; } } } @@ -2636,8 +2636,8 @@ declare global { namespace JSXElements { export interface IonSpinnerAttributes extends HTMLAttributes { color?: string; - mode?: 'ios' | 'md'; duration?: number; + mode?: 'ios' | 'md'; name?: string; paused?: boolean; } @@ -2761,18 +2761,18 @@ declare global { } namespace JSXElements { export interface IonTabAttributes extends HTMLAttributes { - root?: string; - rootParams?: any; - btnId?: string; - path?: string; - title?: string; - icon?: string; badge?: string; badgeStyle?: string; + btnId?: string; enabled?: boolean; + icon?: string; + path?: string; + root?: string; + rootParams?: any; + selected?: boolean; show?: boolean; tabsHideOnSubPages?: boolean; - selected?: boolean; + title?: string; } } } @@ -2802,11 +2802,11 @@ declare global { } namespace JSXElements { export interface IonTabbarAttributes extends HTMLAttributes { - placement?: string; - tabs?: HTMLIonTabElement[]; - selectedTab?: HTMLIonTabElement; - layout?: string; highlight?: boolean; + layout?: string; + placement?: string; + selectedTab?: HTMLIonTabElement; + tabs?: HTMLIonTabElement[]; translucent?: boolean; } } @@ -2839,9 +2839,9 @@ declare global { export interface IonTabsAttributes extends HTMLAttributes { name?: string; tabbarHidden?: boolean; + tabbarHighlight?: boolean; tabbarLayout?: string; tabbarPlacement?: string; - tabbarHighlight?: boolean; translucent?: boolean; } } @@ -2876,6 +2876,7 @@ declare global { autocomplete?: string; autofocus?: boolean; clearOnEdit?: boolean; + cols?: number; disabled?: boolean; maxlength?: number; minlength?: number; @@ -2883,11 +2884,10 @@ declare global { placeholder?: string; readonly?: boolean; required?: boolean; - spellcheck?: boolean; - cols?: number; rows?: number; - wrap?: string; + spellcheck?: boolean; value?: string; + wrap?: string; } } } @@ -3007,18 +3007,18 @@ declare global { } namespace JSXElements { export interface IonToastAttributes extends HTMLAttributes { - message?: string; - cssClass?: string; - duration?: number; - showCloseButton?: boolean; - closeButtonText?: string; - dismissOnPageChange?: boolean; - position?: string; - translucent?: boolean; - toastId?: string; animate?: boolean; + closeButtonText?: string; + cssClass?: string; + dismissOnPageChange?: boolean; + duration?: number; enterAnimation?: AnimationBuilder; leaveAnimation?: AnimationBuilder; + message?: string; + position?: string; + showCloseButton?: boolean; + toastId?: string; + translucent?: boolean; } } } @@ -3048,11 +3048,11 @@ declare global { } namespace JSXElements { export interface IonToggleAttributes extends HTMLAttributes { + checked?: boolean; color?: string; + disabled?: boolean; mode?: 'ios' | 'md'; name?: string; - checked?: boolean; - disabled?: boolean; value?: string; } } diff --git a/packages/core/src/components/action-sheet-controller/readme.md b/packages/core/src/components/action-sheet-controller/readme.md index d97d613305..0879fdaa3a 100644 --- a/packages/core/src/components/action-sheet-controller/readme.md +++ b/packages/core/src/components/action-sheet-controller/readme.md @@ -32,6 +32,8 @@ #### create() +Open an action-sheet with a title, subTitle, and an array of buttons + ---------------------------------------------- diff --git a/packages/core/src/components/action-sheet/readme.md b/packages/core/src/components/action-sheet/readme.md index 25e6991f66..4fdd140e7f 100644 --- a/packages/core/src/components/action-sheet/readme.md +++ b/packages/core/src/components/action-sheet/readme.md @@ -11,46 +11,64 @@ boolean +Enable action-sheet animations. If false, action-sheet will not animate in + #### buttons any +An array of buttons for the action-sheet. See ActionsheetButton type for accepted values + #### cssClass string +Additional class or classes to apply to the action-sheet + #### enableBackdropDismiss boolean +If true, the action-sheet will be dismissed when the backdrop is clicked. + #### enterAnimation any +Animation to use when the action-sheet is created + #### leaveAnimation any +Animation to use when the action-sheet is dismissed + #### subTitle string +Subtitle for the action-sheet + #### title string +Title for the action-sheet + #### translucent boolean +If true, action-sheet will become translucent. Requires support for backdrop-filters. + ## Attributes @@ -58,46 +76,64 @@ boolean boolean +Enable action-sheet animations. If false, action-sheet will not animate in + #### buttons any +An array of buttons for the action-sheet. See ActionsheetButton type for accepted values + #### cssClass string +Additional class or classes to apply to the action-sheet + #### enableBackdropDismiss boolean +If true, the action-sheet will be dismissed when the backdrop is clicked. + #### enterAnimation any +Animation to use when the action-sheet is created + #### leaveAnimation any +Animation to use when the action-sheet is dismissed + #### subTitle string +Subtitle for the action-sheet + #### title string +Title for the action-sheet + #### translucent boolean +If true, action-sheet will become translucent. Requires support for backdrop-filters. + ## Events @@ -123,9 +159,13 @@ boolean #### dismiss() +Dismiss the action-sheet programatically + #### present() +Present the action-sheet after is has been created + ---------------------------------------------- diff --git a/packages/core/src/components/alert-controller/readme.md b/packages/core/src/components/alert-controller/readme.md index 7bf3bdc0a5..23acf83628 100644 --- a/packages/core/src/components/alert-controller/readme.md +++ b/packages/core/src/components/alert-controller/readme.md @@ -46,6 +46,8 @@ building the form within a modal instead. #### create() +Open an alert with a title, subTitle, and an array of buttons + ---------------------------------------------- diff --git a/packages/core/src/components/alert/readme.md b/packages/core/src/components/alert/readme.md index bfbfbf14d5..829317bc8b 100644 --- a/packages/core/src/components/alert/readme.md +++ b/packages/core/src/components/alert/readme.md @@ -11,56 +11,78 @@ boolean +Enable alert animations. If false, alert will not animate in + #### buttons any +Array of buttons to be added to the alert. See AlertButton type for valid options + #### cssClass string +Additional class or classes to apply to the alert + #### enableBackdropDismiss boolean +If true, the alert will be dismissed when the backdrop is clicked. + #### enterAnimation any +Animation to be used when the alert is shown + #### inputs any +Array of input to show in the alert. See AlertInput type for valid options + #### leaveAnimation any +Animation to be used when the alert is dismissed + #### message string +Message to be shown in the alert + #### subTitle string +Subtitle for the alert + #### title string +Title for the alert + #### translucent boolean +If true, alert will become translucent. Requires support for backdrop-filters. + ## Attributes @@ -68,56 +90,78 @@ boolean boolean +Enable alert animations. If false, alert will not animate in + #### buttons any +Array of buttons to be added to the alert. See AlertButton type for valid options + #### cssClass string +Additional class or classes to apply to the alert + #### enableBackdropDismiss boolean +If true, the alert will be dismissed when the backdrop is clicked. + #### enterAnimation any +Animation to be used when the alert is shown + #### inputs any +Array of input to show in the alert. See AlertInput type for valid options + #### leaveAnimation any +Animation to be used when the alert is dismissed + #### message string +Message to be shown in the alert + #### subTitle string +Subtitle for the alert + #### title string +Title for the alert + #### translucent boolean +If true, alert will become translucent. Requires support for backdrop-filters. + ## Events @@ -143,9 +187,13 @@ boolean #### dismiss() +Dismiss the alert programatically + #### present() +Present the alert after is has been created + ---------------------------------------------- diff --git a/packages/core/src/components/button/readme.md b/packages/core/src/components/button/readme.md index fa914383b4..3bb671fc45 100644 --- a/packages/core/src/components/button/readme.md +++ b/packages/core/src/components/button/readme.md @@ -82,51 +82,81 @@ This attribute specifies the size of the button. Setting this attribute will cha string +The type of button. +Possible values are: `"button"`, `"bar-button"`. + #### color string +The color to use from your Sass `$colors` map. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. +For more information, see [Theming your App](/docs/theming/theming-your-app). + #### disabled boolean +If true, sets the button into a disabled state. + #### expand any +Set to `"block"` for a full-width button or to `"full"` for a full-width button +without left and right borders. + #### fill any +Set to `"clear"` for a transparent button, to `"outline"` for a transparent +button with a border, or to `"solid"`. The default style is `"solid"` except inside of +a toolbar, where the default is `"clear"`. + #### href string +Contains a URL or a URL fragment that the hyperlink points to. +If this property is set, an anchor tag will be rendered. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. +For more information, see [Platform Styles](/docs/theming/platform-specific-styles). + #### round boolean +If true, activates a button with rounded corners. + #### size any +The button size. +Possible values are: `"small"`, `"default"`, `"large"`. + #### strong boolean +If true, activates a button with a heavier font weight. + ## Attributes @@ -134,51 +164,81 @@ boolean string +The type of button. +Possible values are: `"button"`, `"bar-button"`. + #### color string +The color to use from your Sass `$colors` map. +Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"dark"`. +For more information, see [Theming your App](/docs/theming/theming-your-app). + #### disabled boolean +If true, sets the button into a disabled state. + #### expand any +Set to `"block"` for a full-width button or to `"full"` for a full-width button +without left and right borders. + #### fill any +Set to `"clear"` for a transparent button, to `"outline"` for a transparent +button with a border, or to `"solid"`. The default style is `"solid"` except inside of +a toolbar, where the default is `"clear"`. + #### href string +Contains a URL or a URL fragment that the hyperlink points to. +If this property is set, an anchor tag will be rendered. + #### mode any +The mode determines which platform styles to use. +Possible values are: `"ios"` or `"md"`. +For more information, see [Platform Styles](/docs/theming/platform-specific-styles). + #### round boolean +If true, activates a button with rounded corners. + #### size any +The button size. +Possible values are: `"small"`, `"default"`, `"large"`. + #### strong boolean +If true, activates a button with a heavier font weight. + ---------------------------------------------- diff --git a/packages/core/src/components/checkbox/readme.md b/packages/core/src/components/checkbox/readme.md index 92bc14f9d3..b84a1fc332 100644 --- a/packages/core/src/components/checkbox/readme.md +++ b/packages/core/src/components/checkbox/readme.md @@ -56,6 +56,8 @@ any string +The name of the control, which is submitted with the form data. + #### value @@ -88,6 +90,8 @@ any string +The name of the control, which is submitted with the form data. + #### value diff --git a/packages/core/src/components/content/readme.md b/packages/core/src/components/content/readme.md index 60519bbb11..b5011519a5 100644 --- a/packages/core/src/components/content/readme.md +++ b/packages/core/src/components/content/readme.md @@ -56,9 +56,13 @@ any #### scrollToBottom() +Scroll to the bottom of the content component. + #### scrollToTop() +Scroll to the top of the content component. + ---------------------------------------------- diff --git a/packages/core/src/components/fab/readme.md b/packages/core/src/components/fab/readme.md index ea7f43f646..9286d70641 100644 --- a/packages/core/src/components/fab/readme.md +++ b/packages/core/src/components/fab/readme.md @@ -58,6 +58,8 @@ The same `ion-fab` container can contain several `ion-fab-list` elements with di #### close() +Close an active FAB list container + ---------------------------------------------- diff --git a/packages/core/src/components/infinite-scroll/readme.md b/packages/core/src/components/infinite-scroll/readme.md index 689899c896..4ae384fd99 100644 --- a/packages/core/src/components/infinite-scroll/readme.md +++ b/packages/core/src/components/infinite-scroll/readme.md @@ -176,6 +176,15 @@ string #### complete() +Call `complete()` within the `infinite` output event handler when +your async operation has completed. For example, the `loading` +state is while the app is performing an asynchronous operation, +such as receiving more data from an AJAX request to add more items +to a data list. Once the data has been received and UI updated, you +then call this method to signify that the loading has completed. +This method will change the infinite scroll's state from `loading` +to `enabled`. + ---------------------------------------------- diff --git a/packages/core/src/components/item-sliding/readme.md b/packages/core/src/components/item-sliding/readme.md index 4a47bceca0..a7fd08a04a 100644 --- a/packages/core/src/components/item-sliding/readme.md +++ b/packages/core/src/components/item-sliding/readme.md @@ -111,6 +111,29 @@ We can call `delete` by either clicking the button, or by doing a full swipe on #### close() +Close the sliding item. Items can also be closed from the [List](../../list/List). + +The sliding item can be closed by grabbing a reference to `ItemSliding`. In the +below example, the template reference variable `slidingItem` is placed on the element +and passed to the `share` method. + +```html + + + + Item + + + Share + + + +``` + +```ts +import { Component } from '@angular/core'; +import { ItemSliding } from 'ionic-angular'; + #### closeOpened() diff --git a/packages/core/src/components/loading-controller/readme.md b/packages/core/src/components/loading-controller/readme.md index 0ed17c9c0b..2f506b1802 100644 --- a/packages/core/src/components/loading-controller/readme.md +++ b/packages/core/src/components/loading-controller/readme.md @@ -40,6 +40,8 @@ in the `usage` section below. #### create() +Create a loading overlay and pass options to it + ---------------------------------------------- diff --git a/packages/core/src/components/loading/readme.md b/packages/core/src/components/loading/readme.md index 445376c7ef..7d707e4ed4 100644 --- a/packages/core/src/components/loading/readme.md +++ b/packages/core/src/components/loading/readme.md @@ -11,41 +11,57 @@ boolean +Toggles whether animation should occur or not + #### content string +Optional text content to display in the loading indicator + #### cssClass string +Additional classes to apply for custom CSS + #### dismissOnPageChange boolean +Dismiss the loading indicator if the page is changed + #### duration number +Number of milliseconds to wait before dismissing the loading indicator + #### enterAnimation any +Animation to use when loading indicator is presented + #### leaveAnimation any +Animation to use when a loading indicator is dismissed + #### showBackdrop boolean +Show the backdrop of not + #### spinner @@ -56,6 +72,8 @@ string boolean +If true, the background will be translucent. Browser support for backdrop-filter is required for the full effect + ## Attributes @@ -63,41 +81,57 @@ boolean boolean +Toggles whether animation should occur or not + #### content string +Optional text content to display in the loading indicator + #### cssClass string +Additional classes to apply for custom CSS + #### dismissOnPageChange boolean +Dismiss the loading indicator if the page is changed + #### duration number +Number of milliseconds to wait before dismissing the loading indicator + #### enterAnimation any +Animation to use when loading indicator is presented + #### leaveAnimation any +Animation to use when a loading indicator is dismissed + #### showBackdrop boolean +Show the backdrop of not + #### spinner @@ -108,6 +142,8 @@ string boolean +If true, the background will be translucent. Browser support for backdrop-filter is required for the full effect + ## Events @@ -133,9 +169,13 @@ boolean #### dismiss() +Dismiss a loading indicator programatically + #### present() +Present a loading overlay after it has been created + ---------------------------------------------- diff --git a/packages/core/src/components/menu-controller/readme.md b/packages/core/src/components/menu-controller/readme.md index 4d6ae9a6eb..203ab57017 100644 --- a/packages/core/src/components/menu-controller/readme.md +++ b/packages/core/src/components/menu-controller/readme.md @@ -18,15 +18,30 @@ #### close() +Programatically close the Menu. If no `menuId` is given as the first +argument then it'll close any menu which is open. If a `menuId` +is given then it'll close that exact menu. + #### createAnimation() #### enable() +Used to enable or disable a menu. For example, there could be multiple +left menus, but only one of them should be able to be opened at the same +time. If there are multiple menus on the same side, then enabling one menu +will also automatically disable all the others that are on the same side. + #### get() +Used to get a menu instance. If a `menuId` is not provided then it'll +return the first menu found. If a `menuId` is `left` or `right`, then +it'll return the enabled menu on that side. Otherwise, if a `menuId` is +provided, then it'll try to find the menu using the menu's `id` +property. If a menu is not found then it'll return `null`. + #### getMenus() @@ -45,12 +60,19 @@ #### open() +Programatically open the Menu. + #### swipeEnable() +Used to enable or disable the ability to swipe open the menu. + #### toggle() +Toggle the menu. If it's closed, it will open, and if opened, it +will close. + ---------------------------------------------- diff --git a/packages/core/src/components/popover-controller/readme.md b/packages/core/src/components/popover-controller/readme.md index ae674c1e3f..9043635df6 100644 --- a/packages/core/src/components/popover-controller/readme.md +++ b/packages/core/src/components/popover-controller/readme.md @@ -28,6 +28,8 @@ view. See the [usage](#usage) section for an example of passing this event. #### create() +Create a popover component instance + ---------------------------------------------- diff --git a/packages/core/src/components/radio-group/readme.md b/packages/core/src/components/radio-group/readme.md index 7fc3508941..d382d8a5d4 100644 --- a/packages/core/src/components/radio-group/readme.md +++ b/packages/core/src/components/radio-group/readme.md @@ -65,6 +65,8 @@ boolean string +The name of the control, which is submitted with the form data. + #### value @@ -87,6 +89,8 @@ boolean string +The name of the control, which is submitted with the form data. + #### value diff --git a/packages/core/src/components/radio/readme.md b/packages/core/src/components/radio/readme.md index 7ec6e5e3c5..9067c585c8 100644 --- a/packages/core/src/components/radio/readme.md +++ b/packages/core/src/components/radio/readme.md @@ -69,6 +69,8 @@ any string +The name of the control, which is submitted with the form data. + #### value @@ -101,6 +103,8 @@ any string +The name of the control, which is submitted with the form data. + #### value diff --git a/packages/core/src/components/range/readme.md b/packages/core/src/components/range/readme.md index d1c6526ead..6a24e0f584 100644 --- a/packages/core/src/components/range/readme.md +++ b/packages/core/src/components/range/readme.md @@ -137,9 +137,17 @@ any #### ratio() +Returns the ratio of the knob's is current location, which is a number +between `0` and `1`. If two knobs are used, this property represents +the lower value. + #### ratioUpper() +Returns the ratio of the upper value's is current location, which is +a number between `0` and `1`. If there is only one knob, then this +will return `null`. + ---------------------------------------------- diff --git a/packages/core/src/components/select-option/readme.md b/packages/core/src/components/select-option/readme.md index 0c62c76d1a..c70e9749c5 100644 --- a/packages/core/src/components/select-option/readme.md +++ b/packages/core/src/components/select-option/readme.md @@ -16,11 +16,15 @@ boolean boolean +If true, the element is selected. + #### value string +The text value of the option. + ## Attributes @@ -33,19 +37,27 @@ boolean boolean +If true, the element is selected. + #### value string +The text value of the option. + ## Events #### ionSelectOptionDidLoad +Emitted when the select option loads. + #### ionSelectOptionDidUnload +Emitted when the select option unloads. + ---------------------------------------------- diff --git a/packages/core/src/components/select/readme.md b/packages/core/src/components/select/readme.md index 1bace11817..9644671989 100644 --- a/packages/core/src/components/select/readme.md +++ b/packages/core/src/components/select/readme.md @@ -11,46 +11,68 @@ string +The text to display on the cancel button. Default: `Cancel`. + #### disabled boolean +If true, the user cannot interact with the select. Defaults to `false`. + #### interface string +The interface the select should use: `action-sheet`, `popover` or `alert`. Default: `alert`. + #### interfaceOptions any +Any additional options that the `alert`, `action-sheet` or `popover` interface +can take. See the [AlertController API docs](../../alert/AlertController/#create), the +[ActionSheetController API docs](../../action-sheet/ActionSheetController/#create) and the +[PopoverController API docs](../../popover/PopoverController/#create) for the +create options for each interface. + #### multiple boolean +If true, the select can accept multiple values. + #### name string +The name of the control, which is submitted with the form data. + #### okText string +The text to display on the ok button. Default: `OK`. + #### placeholder string +The text to display when the select is empty. + #### selectedText string +The text to display instead of the selected option's value. + #### value @@ -63,46 +85,68 @@ any string +The text to display on the cancel button. Default: `Cancel`. + #### disabled boolean +If true, the user cannot interact with the select. Defaults to `false`. + #### interface string +The interface the select should use: `action-sheet`, `popover` or `alert`. Default: `alert`. + #### interfaceOptions any +Any additional options that the `alert`, `action-sheet` or `popover` interface +can take. See the [AlertController API docs](../../alert/AlertController/#create), the +[ActionSheetController API docs](../../action-sheet/ActionSheetController/#create) and the +[PopoverController API docs](../../popover/PopoverController/#create) for the +create options for each interface. + #### multiple boolean +If true, the select can accept multiple values. + #### name string +The name of the control, which is submitted with the form data. + #### okText string +The text to display on the ok button. Default: `OK`. + #### placeholder string +The text to display when the select is empty. + #### selectedText string +The text to display instead of the selected option's value. + #### value @@ -113,15 +157,23 @@ any #### ionBlur +Emitted when the select loses focus. + #### ionCancel +Emitted when the selection is cancelled. + #### ionChange +Emitted when the value has changed. + #### ionFocus +Emitted when the select has focus. + #### ionStyle diff --git a/packages/core/src/components/toggle/readme.md b/packages/core/src/components/toggle/readme.md index bf9acff78b..beed6a2696 100644 --- a/packages/core/src/components/toggle/readme.md +++ b/packages/core/src/components/toggle/readme.md @@ -56,6 +56,8 @@ any string +The name of the control, which is submitted with the form data. + #### value @@ -88,6 +90,8 @@ any string +The name of the control, which is submitted with the form data. + #### value