import './stencil.core'; /* tslint:disable */ /** * This is an autogenerated file created by the Stencil compiler. * It contains typing information for all components that exist in this project. */ import './stencil.core'; import 'ionicons'; import { ActionSheetButton, ActionSheetOptions, AlertButton, AlertInput, AlertOptions, AnimationBuilder, CheckboxChangeEventDetail, Color, ComponentProps, ComponentRef, DatetimeChangeEventDetail, DatetimeOptions, DomRenderFn, FrameworkDelegate, HeaderFn, InputChangeEventDetail, ItemHeightFn, ItemRenderFn, ItemReorderEventDetail, LoadingOptions, MenuChangeEventDetail, MenuControllerI, ModalOptions, Mode, NavComponent, NavOptions, OverlayEventDetail, OverlaySelect, PickerButton, PickerColumn, PickerOptions, PopoverOptions, RadioChangeEventDetail, RadioGroupChangeEventDetail, RangeChangeEventDetail, RangeValue, RefresherEventDetail, RouteID, RouterDirection, RouterEventDetail, RouterOutletOptions, RouteWrite, ScrollBaseDetail, ScrollDetail, SearchbarChangeEventDetail, SegmentButtonLayout, SegmentChangeEventDetail, SelectChangeEventDetail, SelectInterface, SelectPopoverOption, Side, SpinnerTypes, StyleEventDetail, SwipeGestureHandler, TabBarChangedEventDetail, TabButtonClickEventDetail, TabButtonLayout, TextareaChangeEventDetail, TextFieldTypes, ToastOptions, ToggleChangeEventDetail, TransitionDoneFn, TransitionInstruction, ViewController, } from './interface'; import { EventEmitter, } from './stencil.core'; export namespace Components { interface IonActionSheetController { /** * Create an action sheet overlay with action sheet options. */ 'create': (opts: ActionSheetOptions) => Promise; /** * Dismiss the open action sheet overlay. */ 'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise; /** * Get the most recently opened action sheet overlay. */ 'getTop': () => Promise; } interface IonActionSheetControllerAttributes extends StencilHTMLAttributes {} interface IonActionSheet { /** * If `true`, the action sheet will animate. */ 'animated': boolean; /** * If `true`, the action sheet will be dismissed when the backdrop is clicked. */ 'backdropDismiss': boolean; /** * An array of buttons for the action sheet. */ 'buttons': (ActionSheetButton | string)[]; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Dismiss the action sheet overlay after it has been presented. */ 'dismiss': (data?: any, role?: string | undefined) => Promise; /** * Animation to use when the action sheet is presented. */ 'enterAnimation'?: AnimationBuilder; /** * Title for the action sheet. */ 'header'?: string; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose': boolean; /** * Animation to use when the action sheet is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Returns a promise that resolves when the action-sheet did dismiss. */ 'onDidDismiss': () => Promise>; /** * Returns a promise that resolves when the action-sheet will dismiss. */ 'onWillDismiss': () => Promise>; 'overlayIndex': number; /** * Present the action sheet overlay after it has been created. */ 'present': () => Promise; /** * Subtitle for the action sheet. */ 'subHeader'?: string; /** * If `true`, the action sheet will be translucent. Only applies when the mode is `"ios"` and the device supports backdrop-filter. */ 'translucent': boolean; } interface IonActionSheetAttributes extends StencilHTMLAttributes { /** * If `true`, the action sheet will animate. */ 'animated'?: boolean; /** * If `true`, the action sheet will be dismissed when the backdrop is clicked. */ 'backdropDismiss'?: boolean; /** * An array of buttons for the action sheet. */ 'buttons': (ActionSheetButton | string)[]; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Animation to use when the action sheet is presented. */ 'enterAnimation'?: AnimationBuilder; /** * Title for the action sheet. */ 'header'?: string; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose'?: boolean; /** * Animation to use when the action sheet is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted after the alert has dismissed. */ 'onIonActionSheetDidDismiss'?: (event: CustomEvent) => void; /** * Emitted after the alert has presented. */ 'onIonActionSheetDidPresent'?: (event: CustomEvent) => void; /** * Emitted before the alert has dismissed. */ 'onIonActionSheetWillDismiss'?: (event: CustomEvent) => void; /** * Emitted before the alert has presented. */ 'onIonActionSheetWillPresent'?: (event: CustomEvent) => void; /** * Subtitle for the action sheet. */ 'subHeader'?: string; /** * If `true`, the action sheet will be translucent. Only applies when the mode is `"ios"` and the device supports backdrop-filter. */ 'translucent'?: boolean; } interface IonAlertController { /** * Create an alert overlay with alert options */ 'create': (opts: AlertOptions) => Promise; /** * Dismiss the open alert overlay. */ 'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise; /** * Get the most recently opened alert overlay. */ 'getTop': () => Promise; } interface IonAlertControllerAttributes extends StencilHTMLAttributes {} interface IonAlert { /** * If `true`, the alert will animate. */ 'animated': boolean; /** * If `true`, the alert will be dismissed when the backdrop is clicked. */ 'backdropDismiss': boolean; /** * Array of buttons to be added to the alert. */ 'buttons': (AlertButton | string)[]; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Dismiss the alert overlay after it has been presented. */ 'dismiss': (data?: any, role?: string | undefined) => Promise; /** * Animation to use when the alert is presented. */ 'enterAnimation'?: AnimationBuilder; /** * The main title in the heading of the alert. */ 'header'?: string; /** * Array of input to show in the alert. */ 'inputs': AlertInput[]; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose': boolean; /** * Animation to use when the alert is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The main message to be displayed in the alert. */ 'message'?: string; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Returns a promise that resolves when the alert did dismiss. */ 'onDidDismiss': () => Promise>; /** * Returns a promise that resolves when the alert will dismiss. */ 'onWillDismiss': () => Promise>; 'overlayIndex': number; /** * Present the alert overlay after it has been created. */ 'present': () => Promise; /** * The subtitle in the heading of the alert. Displayed under the title. */ 'subHeader'?: string; /** * If `true`, the alert will be translucent. */ 'translucent': boolean; } interface IonAlertAttributes extends StencilHTMLAttributes { /** * If `true`, the alert will animate. */ 'animated'?: boolean; /** * If `true`, the alert will be dismissed when the backdrop is clicked. */ 'backdropDismiss'?: boolean; /** * Array of buttons to be added to the alert. */ 'buttons'?: (AlertButton | string)[]; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Animation to use when the alert is presented. */ 'enterAnimation'?: AnimationBuilder; /** * The main title in the heading of the alert. */ 'header'?: string; /** * Array of input to show in the alert. */ 'inputs'?: AlertInput[]; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose'?: boolean; /** * Animation to use when the alert is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The main message to be displayed in the alert. */ 'message'?: string; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted after the alert has dismissed. */ 'onIonAlertDidDismiss'?: (event: CustomEvent) => void; /** * Emitted after the alert has presented. */ 'onIonAlertDidPresent'?: (event: CustomEvent) => void; /** * Emitted before the alert has dismissed. */ 'onIonAlertWillDismiss'?: (event: CustomEvent) => void; /** * Emitted before the alert has presented. */ 'onIonAlertWillPresent'?: (event: CustomEvent) => void; /** * The subtitle in the heading of the alert. Displayed under the title. */ 'subHeader'?: string; /** * If `true`, the alert will be translucent. */ 'translucent'?: boolean; } interface IonAnchor { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection': RouterDirection; } interface IonAnchorAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection'?: RouterDirection; } interface IonApp {} interface IonAppAttributes extends StencilHTMLAttributes {} interface IonAvatar {} interface IonAvatarAttributes extends StencilHTMLAttributes {} interface IonBackButton { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The url to navigate back to by default when there is no history. */ 'defaultHref'?: string; /** * The icon name to use for the back button. */ 'icon'?: string | null; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The text to display in the back button. */ 'text'?: string | null; } interface IonBackButtonAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The url to navigate back to by default when there is no history. */ 'defaultHref'?: string; /** * The icon name to use for the back button. */ 'icon'?: string | null; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * The text to display in the back button. */ 'text'?: string | null; } interface IonBackdrop { /** * If `true`, the backdrop will stop propagation on tap. */ 'stopPropagation': boolean; /** * If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event. */ 'tappable': boolean; /** * If `true`, the backdrop will be visible. */ 'visible': boolean; } interface IonBackdropAttributes extends StencilHTMLAttributes { /** * Emitted when the backdrop is tapped. */ 'onIonBackdropTap'?: (event: CustomEvent) => void; /** * If `true`, the backdrop will stop propagation on tap. */ 'stopPropagation'?: boolean; /** * If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event. */ 'tappable'?: boolean; /** * If `true`, the backdrop will be visible. */ 'visible'?: boolean; } interface IonBadge { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonBadgeAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonButton { /** * The type of button. */ 'buttonType': string; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the button. */ 'disabled': boolean; /** * Set to `"block"` for a full-width button or to `"full"` for a full-width button without left and right borders. */ 'expand'?: 'full' | 'block'; /** * 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"`. */ 'fill'?: 'clear' | 'outline' | 'solid' | 'default'; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection': RouterDirection; /** * The button shape. */ 'shape'?: 'round'; /** * The button size. */ 'size'?: 'small' | 'default' | 'large'; /** * If `true`, activates a button with a heavier font weight. */ 'strong': boolean; /** * The type of the button. */ 'type': 'submit' | 'reset' | 'button'; } interface IonButtonAttributes extends StencilHTMLAttributes { /** * The type of button. */ 'buttonType'?: string; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the button. */ 'disabled'?: boolean; /** * Set to `"block"` for a full-width button or to `"full"` for a full-width button without left and right borders. */ 'expand'?: 'full' | 'block'; /** * 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"`. */ 'fill'?: 'clear' | 'outline' | 'solid' | 'default'; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted when the button loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the button has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection'?: RouterDirection; /** * The button shape. */ 'shape'?: 'round'; /** * The button size. */ 'size'?: 'small' | 'default' | 'large'; /** * If `true`, activates a button with a heavier font weight. */ 'strong'?: boolean; /** * The type of the button. */ 'type'?: 'submit' | 'reset' | 'button'; } interface IonButtons {} interface IonButtonsAttributes extends StencilHTMLAttributes {} interface IonCardContent { /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonCardContentAttributes extends StencilHTMLAttributes { /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonCardHeader { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * If `true`, the card header will be translucent. */ 'translucent': boolean; } interface IonCardHeaderAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * If `true`, the card header will be translucent. */ 'translucent'?: boolean; } interface IonCardSubtitle { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonCardSubtitleAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonCardTitle { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonCardTitleAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonCard { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonCardAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonCheckbox { /** * If `true`, the checkbox is selected. */ 'checked': boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the checkbox. */ 'disabled': boolean; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The name of the control, which is submitted with the form data. */ 'name': string; /** * The value of the toggle does not mean if it's checked or not, use the `checked` property for that. The value of a toggle is analogous to the value of a ``, it's only used when the toggle participates in a native `
`. */ 'value': string; } interface IonCheckboxAttributes extends StencilHTMLAttributes { /** * If `true`, the checkbox is selected. */ 'checked'?: boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the checkbox. */ 'disabled'?: boolean; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * The name of the control, which is submitted with the form data. */ 'name'?: string; /** * Emitted when the toggle loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the checked property has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * Emitted when the toggle has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * The value of the toggle does not mean if it's checked or not, use the `checked` property for that. The value of a toggle is analogous to the value of a ``, it's only used when the toggle participates in a native ``. */ 'value'?: string; } interface IonChip { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Display an outline style button. */ 'outline': boolean; } interface IonChipAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Display an outline style button. */ 'outline'?: boolean; } interface IonCol { /** * The amount to offset the column, in terms of how many columns it should shift to the end of the total available. */ 'offset'?: string; /** * The amount to offset the column for lg screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetLg'?: string; /** * The amount to offset the column for md screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetMd'?: string; /** * The amount to offset the column for sm screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetSm'?: string; /** * The amount to offset the column for xl screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetXl'?: string; /** * The amount to offset the column for xs screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetXs'?: string; /** * The amount to pull the column, in terms of how many columns it should shift to the start of the total available. */ 'pull'?: string; /** * The amount to pull the column for lg screens, in terms of how many columns it should shift to the start of the total available. */ 'pullLg'?: string; /** * The amount to pull the column for md screens, in terms of how many columns it should shift to the start of the total available. */ 'pullMd'?: string; /** * The amount to pull the column for sm screens, in terms of how many columns it should shift to the start of the total available. */ 'pullSm'?: string; /** * The amount to pull the column for xl screens, in terms of how many columns it should shift to the start of the total available. */ 'pullXl'?: string; /** * The amount to pull the column for xs screens, in terms of how many columns it should shift to the start of the total available. */ 'pullXs'?: string; /** * The amount to push the column, in terms of how many columns it should shift to the end of the total available. */ 'push'?: string; /** * The amount to push the column for lg screens, in terms of how many columns it should shift to the end of the total available. */ 'pushLg'?: string; /** * The amount to push the column for md screens, in terms of how many columns it should shift to the end of the total available. */ 'pushMd'?: string; /** * The amount to push the column for sm screens, in terms of how many columns it should shift to the end of the total available. */ 'pushSm'?: string; /** * The amount to push the column for xl screens, in terms of how many columns it should shift to the end of the total available. */ 'pushXl'?: string; /** * The amount to push the column for xs screens, in terms of how many columns it should shift to the end of the total available. */ 'pushXs'?: string; /** * The size of the column, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'size'?: string; /** * The size of the column for lg screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeLg'?: string; /** * The size of the column for md screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeMd'?: string; /** * The size of the column for sm screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeSm'?: string; /** * The size of the column for xl screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeXl'?: string; /** * The size of the column for xs screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeXs'?: string; } interface IonColAttributes extends StencilHTMLAttributes { /** * The amount to offset the column, in terms of how many columns it should shift to the end of the total available. */ 'offset'?: string; /** * The amount to offset the column for lg screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetLg'?: string; /** * The amount to offset the column for md screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetMd'?: string; /** * The amount to offset the column for sm screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetSm'?: string; /** * The amount to offset the column for xl screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetXl'?: string; /** * The amount to offset the column for xs screens, in terms of how many columns it should shift to the end of the total available. */ 'offsetXs'?: string; /** * The amount to pull the column, in terms of how many columns it should shift to the start of the total available. */ 'pull'?: string; /** * The amount to pull the column for lg screens, in terms of how many columns it should shift to the start of the total available. */ 'pullLg'?: string; /** * The amount to pull the column for md screens, in terms of how many columns it should shift to the start of the total available. */ 'pullMd'?: string; /** * The amount to pull the column for sm screens, in terms of how many columns it should shift to the start of the total available. */ 'pullSm'?: string; /** * The amount to pull the column for xl screens, in terms of how many columns it should shift to the start of the total available. */ 'pullXl'?: string; /** * The amount to pull the column for xs screens, in terms of how many columns it should shift to the start of the total available. */ 'pullXs'?: string; /** * The amount to push the column, in terms of how many columns it should shift to the end of the total available. */ 'push'?: string; /** * The amount to push the column for lg screens, in terms of how many columns it should shift to the end of the total available. */ 'pushLg'?: string; /** * The amount to push the column for md screens, in terms of how many columns it should shift to the end of the total available. */ 'pushMd'?: string; /** * The amount to push the column for sm screens, in terms of how many columns it should shift to the end of the total available. */ 'pushSm'?: string; /** * The amount to push the column for xl screens, in terms of how many columns it should shift to the end of the total available. */ 'pushXl'?: string; /** * The amount to push the column for xs screens, in terms of how many columns it should shift to the end of the total available. */ 'pushXs'?: string; /** * The size of the column, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'size'?: string; /** * The size of the column for lg screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeLg'?: string; /** * The size of the column for md screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeMd'?: string; /** * The size of the column for sm screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeSm'?: string; /** * The size of the column for xl screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeXl'?: string; /** * The size of the column for xs screens, in terms of how many columns it should take up out of the total available. If `"auto"` is passed, the column will be the size of its content. */ 'sizeXs'?: string; } interface IonContent { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true` and the content does not cause an overflow scroll, the scroll interaction will cause a bounce. If the content exceeds the bounds of ionContent, nothing will change. Note, the does not disable the system bounce on iOS. That is an OS level setting. */ 'forceOverscroll'?: boolean; /** * If `true`, the content will scroll behind the headers and footers. This effect can easily be seen by setting the toolbar to transparent. */ 'fullscreen': boolean; /** * Returns the element where the actual scrolling takes places. This element is the one you could subscribe to `scroll` events or manually modify `scrollTop`, however, it's recommended to use the API provided by `ion-content`: Ie. Using `ionScroll`, `ionScrollStart`, `ionScrollEnd` for scrolling events and scrollToPoint() to scroll the content into a certain point. */ 'getScrollElement': () => Promise; /** * Scroll by a specified X/Y distance in the component */ 'scrollByPoint': (x: number, y: number, duration: number) => Promise; /** * Because of performance reasons, ionScroll events are disabled by default, in order to enable them and start listening from (ionScroll), set this property to `true`. */ 'scrollEvents': boolean; /** * Scroll to the bottom of the component */ 'scrollToBottom': (duration?: number) => Promise; /** * Scroll to a specified X/Y location in the component */ 'scrollToPoint': (x: number | null | undefined, y: number | null | undefined, duration?: number) => Promise; /** * Scroll to the top of the component */ 'scrollToTop': (duration?: number) => Promise; /** * If you want to enable the content scrolling in the X axis, set this property to `true`. */ 'scrollX': boolean; /** * If you want to disable the content scrolling in the Y axis, set this property to `false`. */ 'scrollY': boolean; } interface IonContentAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true` and the content does not cause an overflow scroll, the scroll interaction will cause a bounce. If the content exceeds the bounds of ionContent, nothing will change. Note, the does not disable the system bounce on iOS. That is an OS level setting. */ 'forceOverscroll'?: boolean; /** * If `true`, the content will scroll behind the headers and footers. This effect can easily be seen by setting the toolbar to transparent. */ 'fullscreen'?: boolean; /** * Emitted while scrolling. This event is disabled by default. Look at the property: `scrollEvents` */ 'onIonScroll'?: (event: CustomEvent) => void; /** * Emitted when the scroll has ended. */ 'onIonScrollEnd'?: (event: CustomEvent) => void; /** * Emitted when the scroll has started. */ 'onIonScrollStart'?: (event: CustomEvent) => void; /** * Because of performance reasons, ionScroll events are disabled by default, in order to enable them and start listening from (ionScroll), set this property to `true`. */ 'scrollEvents'?: boolean; /** * If you want to enable the content scrolling in the X axis, set this property to `true`. */ 'scrollX'?: boolean; /** * If you want to disable the content scrolling in the Y axis, set this property to `false`. */ 'scrollY'?: boolean; } interface IonDatetime { /** * The text to display on the picker's cancel button. */ 'cancelText': string; /** * Full day of the week names. This can be used to provide locale names for each day in the week. Defaults to English. */ 'dayNames'?: string[] | string; /** * Short abbreviated day of the week names. This can be used to provide locale names for each day in the week. Defaults to English. */ 'dayShortNames'?: string[] | string; /** * Values used to create the list of selectable days. By default every day is shown for the given month. However, to control exactly which days of the month to display, the `dayValues` input can take a number, an array of numbers, or a string of comma separated numbers. Note that even if the array days have an invalid number for the selected month, like `31` in February, it will correctly not show days which are not valid for the selected month. */ 'dayValues'?: number[] | number | string; /** * If `true`, the user cannot interact with the datetime. */ 'disabled': boolean; /** * The display format of the date and time as text that shows within the item. When the `pickerFormat` input is not used, then the `displayFormat` is used for both display the formatted text, and determining the datetime picker's columns. See the `pickerFormat` input description for more info. Defaults to `MMM D, YYYY`. */ 'displayFormat': string; /** * The text to display on the picker's "Done" button. */ 'doneText': string; /** * Values used to create the list of selectable hours. By default the hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However, to control exactly which hours to display, the `hourValues` input can take a number, an array of numbers, or a string of comma separated numbers. */ 'hourValues'?: number[] | number | string; /** * The maximum datetime allowed. Value must be a date string following the [ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime), `1996-12-19`. The format does not have to be specific to an exact datetime. For example, the maximum could just be the year, such as `1994`. Defaults to the end of this year. */ 'max'?: string; /** * The minimum datetime allowed. Value must be a date string following the [ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime), such as `1996-12-19`. The format does not have to be specific to an exact datetime. For example, the minimum could just be the year, such as `1994`. Defaults to the beginning of the year, 100 years ago from today. */ 'min'?: string; /** * Values used to create the list of selectable minutes. By default the minutes range from `0` to `59`. However, to control exactly which minutes to display, the `minuteValues` input can take a number, an array of numbers, or a string of comma separated numbers. For example, if the minute selections should only be every 15 minutes, then this input value would be `minuteValues="0,15,30,45"`. */ 'minuteValues'?: number[] | number | string; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Full names for each month name. This can be used to provide locale month names. Defaults to English. */ 'monthNames'?: string[] | string; /** * Short abbreviated names for each month name. This can be used to provide locale month names. Defaults to English. */ 'monthShortNames'?: string[] | string; /** * Values used to create the list of selectable months. By default the month values range from `1` to `12`. However, to control exactly which months to display, the `monthValues` input can take a number, an array of numbers, or a string of comma separated numbers. For example, if only summer months should be shown, then this input value would be `monthValues="6,7,8"`. Note that month numbers do *not* have a zero-based index, meaning January's value is `1`, and December's is `12`. */ 'monthValues'?: number[] | number | string; /** * The name of the control, which is submitted with the form data. */ 'name': string; /** * Opens the datetime overlay. */ 'open': () => Promise; /** * The format of the date and time picker columns the user selects. A datetime input can have one or many datetime parts, each getting their own column which allow individual selection of that particular datetime part. For example, year and month columns are two individually selectable columns which help choose an exact date from the datetime picker. Each column follows the string parse format. Defaults to use `displayFormat`. */ 'pickerFormat'?: string; /** * Any additional options that the picker interface can accept. See the [Picker API docs](../../picker/Picker) for the picker options. */ 'pickerOptions'?: DatetimeOptions; /** * The text to display when there's no date selected yet. Using lowercase to match the input attribute */ 'placeholder'?: string | null; /** * If `true`, the datetime appears normal but is not interactive. */ 'readonly': boolean; /** * The value of the datetime as a valid ISO 8601 datetime string. */ 'value'?: string | null; /** * Values used to create the list of selectable years. By default the year values range between the `min` and `max` datetime inputs. However, to control exactly which years to display, the `yearValues` input can take a number, an array of numbers, or string of comma separated numbers. For example, to show upcoming and recent leap years, then this input's value would be `yearValues="2024,2020,2016,2012,2008"`. */ 'yearValues'?: number[] | number | string; } interface IonDatetimeAttributes extends StencilHTMLAttributes { /** * The text to display on the picker's cancel button. */ 'cancelText'?: string; /** * Full day of the week names. This can be used to provide locale names for each day in the week. Defaults to English. */ 'dayNames'?: string[] | string; /** * Short abbreviated day of the week names. This can be used to provide locale names for each day in the week. Defaults to English. */ 'dayShortNames'?: string[] | string; /** * Values used to create the list of selectable days. By default every day is shown for the given month. However, to control exactly which days of the month to display, the `dayValues` input can take a number, an array of numbers, or a string of comma separated numbers. Note that even if the array days have an invalid number for the selected month, like `31` in February, it will correctly not show days which are not valid for the selected month. */ 'dayValues'?: number[] | number | string; /** * If `true`, the user cannot interact with the datetime. */ 'disabled'?: boolean; /** * The display format of the date and time as text that shows within the item. When the `pickerFormat` input is not used, then the `displayFormat` is used for both display the formatted text, and determining the datetime picker's columns. See the `pickerFormat` input description for more info. Defaults to `MMM D, YYYY`. */ 'displayFormat'?: string; /** * The text to display on the picker's "Done" button. */ 'doneText'?: string; /** * Values used to create the list of selectable hours. By default the hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However, to control exactly which hours to display, the `hourValues` input can take a number, an array of numbers, or a string of comma separated numbers. */ 'hourValues'?: number[] | number | string; /** * The maximum datetime allowed. Value must be a date string following the [ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime), `1996-12-19`. The format does not have to be specific to an exact datetime. For example, the maximum could just be the year, such as `1994`. Defaults to the end of this year. */ 'max'?: string; /** * The minimum datetime allowed. Value must be a date string following the [ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime), such as `1996-12-19`. The format does not have to be specific to an exact datetime. For example, the minimum could just be the year, such as `1994`. Defaults to the beginning of the year, 100 years ago from today. */ 'min'?: string; /** * Values used to create the list of selectable minutes. By default the minutes range from `0` to `59`. However, to control exactly which minutes to display, the `minuteValues` input can take a number, an array of numbers, or a string of comma separated numbers. For example, if the minute selections should only be every 15 minutes, then this input value would be `minuteValues="0,15,30,45"`. */ 'minuteValues'?: number[] | number | string; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Full names for each month name. This can be used to provide locale month names. Defaults to English. */ 'monthNames'?: string[] | string; /** * Short abbreviated names for each month name. This can be used to provide locale month names. Defaults to English. */ 'monthShortNames'?: string[] | string; /** * Values used to create the list of selectable months. By default the month values range from `1` to `12`. However, to control exactly which months to display, the `monthValues` input can take a number, an array of numbers, or a string of comma separated numbers. For example, if only summer months should be shown, then this input value would be `monthValues="6,7,8"`. Note that month numbers do *not* have a zero-based index, meaning January's value is `1`, and December's is `12`. */ 'monthValues'?: number[] | number | string; /** * The name of the control, which is submitted with the form data. */ 'name'?: string; /** * Emitted when the datetime loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the datetime selection was cancelled. */ 'onIonCancel'?: (event: CustomEvent) => void; /** * Emitted when the value (selected date) has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * Emitted when the datetime has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * The format of the date and time picker columns the user selects. A datetime input can have one or many datetime parts, each getting their own column which allow individual selection of that particular datetime part. For example, year and month columns are two individually selectable columns which help choose an exact date from the datetime picker. Each column follows the string parse format. Defaults to use `displayFormat`. */ 'pickerFormat'?: string; /** * Any additional options that the picker interface can accept. See the [Picker API docs](../../picker/Picker) for the picker options. */ 'pickerOptions'?: DatetimeOptions; /** * The text to display when there's no date selected yet. Using lowercase to match the input attribute */ 'placeholder'?: string | null; /** * If `true`, the datetime appears normal but is not interactive. */ 'readonly'?: boolean; /** * The value of the datetime as a valid ISO 8601 datetime string. */ 'value'?: string | null; /** * Values used to create the list of selectable years. By default the year values range between the `min` and `max` datetime inputs. However, to control exactly which years to display, the `yearValues` input can take a number, an array of numbers, or string of comma separated numbers. For example, to show upcoming and recent leap years, then this input's value would be `yearValues="2024,2020,2016,2012,2008"`. */ 'yearValues'?: number[] | number | string; } interface IonFabButton { /** * If `true`, the fab button will be show a close icon. */ 'activated': boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the fab button. */ 'disabled': boolean; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection': RouterDirection; /** * If `true`, the fab button will show when in a fab-list. */ 'show': boolean; /** * The size of the button. Set this to `small` in order to have a mini fab. */ 'size'?: 'small'; /** * If `true`, the fab button will be translucent. */ 'translucent': boolean; /** * The type of the button. */ 'type': 'submit' | 'reset' | 'button'; } interface IonFabButtonAttributes extends StencilHTMLAttributes { /** * If `true`, the fab button will be show a close icon. */ 'activated'?: boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the fab button. */ 'disabled'?: boolean; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted when the button loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the button has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection'?: RouterDirection; /** * If `true`, the fab button will show when in a fab-list. */ 'show'?: boolean; /** * The size of the button. Set this to `small` in order to have a mini fab. */ 'size'?: 'small'; /** * If `true`, the fab button will be translucent. */ 'translucent'?: boolean; /** * The type of the button. */ 'type'?: 'submit' | 'reset' | 'button'; } interface IonFabList { /** * If `true`, the fab list will be show all fab buttons in the list. */ 'activated': boolean; /** * The side the fab list will show on relative to the main fab button. */ 'side': 'start' | 'end' | 'top' | 'bottom'; } interface IonFabListAttributes extends StencilHTMLAttributes { /** * If `true`, the fab list will be show all fab buttons in the list. */ 'activated'?: boolean; /** * The side the fab list will show on relative to the main fab button. */ 'side'?: 'start' | 'end' | 'top' | 'bottom'; } interface IonFab { /** * If `true`, both the `ion-fab-button` and all `ion-fab-list` inside `ion-fab` will become active. That means `ion-fab-button` will become a `close` icon and `ion-fab-list` will become visible. */ 'activated': boolean; /** * Close an active FAB list container */ 'close': () => void; /** * If `true`, the fab will display on the edge of the header if `vertical` is `"top"`, and on the edge of the footer if it is `"bottom"`. Should be used with a `fixed` slot. */ 'edge': boolean; /** * Where to align the fab horizontally in the viewport. */ 'horizontal'?: 'start' | 'end' | 'center'; /** * Where to align the fab vertically in the viewport. */ 'vertical'?: 'top' | 'bottom' | 'center'; } interface IonFabAttributes extends StencilHTMLAttributes { /** * If `true`, both the `ion-fab-button` and all `ion-fab-list` inside `ion-fab` will become active. That means `ion-fab-button` will become a `close` icon and `ion-fab-list` will become visible. */ 'activated'?: boolean; /** * If `true`, the fab will display on the edge of the header if `vertical` is `"top"`, and on the edge of the footer if it is `"bottom"`. Should be used with a `fixed` slot. */ 'edge'?: boolean; /** * Where to align the fab horizontally in the viewport. */ 'horizontal'?: 'start' | 'end' | 'center'; /** * Where to align the fab vertically in the viewport. */ 'vertical'?: 'top' | 'bottom' | 'center'; } interface IonFooter { /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * If `true`, the footer will be translucent. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content. */ 'translucent': boolean; } interface IonFooterAttributes extends StencilHTMLAttributes { /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * If `true`, the footer will be translucent. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content. */ 'translucent'?: boolean; } interface IonGrid { /** * If `true`, the grid will have a fixed width based on the screen size. */ 'fixed': boolean; } interface IonGridAttributes extends StencilHTMLAttributes { /** * If `true`, the grid will have a fixed width based on the screen size. */ 'fixed'?: boolean; } interface IonHeader { /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * If `true`, the header will be translucent. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content. */ 'translucent': boolean; } interface IonHeaderAttributes extends StencilHTMLAttributes { /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * If `true`, the header will be translucent. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content. */ 'translucent'?: boolean; } interface IonImg { /** * This attribute defines the alternative text describing the image. Users will see this text displayed if the image URL is wrong, the image is not in one of the supported formats, or if the image is not yet downloaded. */ 'alt'?: string; /** * The image URL. This attribute is mandatory for the element. */ 'src'?: string; } interface IonImgAttributes extends StencilHTMLAttributes { /** * This attribute defines the alternative text describing the image. Users will see this text displayed if the image URL is wrong, the image is not in one of the supported formats, or if the image is not yet downloaded. */ 'alt'?: string; /** * Emitted when the img src is loaded */ 'onIonImgDidLoad'?: (event: CustomEvent) => void; /** * The image URL. This attribute is mandatory for the element. */ 'src'?: string; } interface IonInfiniteScrollContent { /** * An animated SVG spinner that shows while loading. */ 'loadingSpinner'?: SpinnerTypes | null; /** * Optional text to display while loading. */ 'loadingText'?: string; } interface IonInfiniteScrollContentAttributes extends StencilHTMLAttributes { /** * An animated SVG spinner that shows while loading. */ 'loadingSpinner'?: SpinnerTypes | null; /** * Optional text to display while loading. */ 'loadingText'?: string; } interface IonInfiniteScroll { /** * Call `complete()` within the `ionInfinite` 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`. */ 'complete': () => void; /** * If `true`, the infinite scroll will be hidden and scroll event listeners will be removed. Set this to true to disable the infinite scroll from actively trying to receive new data while scrolling. This is useful when it is known that there is no more data that can be added, and the infinite scroll is no longer needed. */ 'disabled': boolean; /** * The position of the infinite scroll element. The value can be either `top` or `bottom`. */ 'position': 'top' | 'bottom'; /** * The threshold distance from the bottom of the content to call the `infinite` output event when scrolled. The threshold value can be either a percent, or in pixels. For example, use the value of `10%` for the `infinite` output event to get called when the user has scrolled 10% from the bottom of the page. Use the value `100px` when the scroll is within 100 pixels from the bottom of the page. */ 'threshold': string; } interface IonInfiniteScrollAttributes extends StencilHTMLAttributes { /** * If `true`, the infinite scroll will be hidden and scroll event listeners will be removed. Set this to true to disable the infinite scroll from actively trying to receive new data while scrolling. This is useful when it is known that there is no more data that can be added, and the infinite scroll is no longer needed. */ 'disabled'?: boolean; /** * Emitted when the scroll reaches the threshold distance. From within your infinite handler, you must call the infinite scroll's `complete()` method when your async operation has completed. */ 'onIonInfinite'?: (event: CustomEvent) => void; /** * The position of the infinite scroll element. The value can be either `top` or `bottom`. */ 'position'?: 'top' | 'bottom'; /** * The threshold distance from the bottom of the content to call the `infinite` output event when scrolled. The threshold value can be either a percent, or in pixels. For example, use the value of `10%` for the `infinite` output event to get called when the user has scrolled 10% from the bottom of the page. Use the value `100px` when the scroll is within 100 pixels from the bottom of the page. */ 'threshold'?: string; } interface IonInput { /** * If the value of the type attribute is `"file"`, then this attribute will indicate the types of files that the server accepts, otherwise it will be ignored. The value must be a comma-separated list of unique content type specifiers. */ 'accept'?: string; /** * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. */ 'autocapitalize': string; /** * Indicates whether the value of the control can be automatically completed by the browser. */ 'autocomplete': 'on' | 'off'; /** * Whether auto correction should be enabled when the user is entering/editing the text value. */ 'autocorrect': 'on' | 'off'; /** * This Boolean attribute lets you specify that a form control should have input focus when the page loads. */ 'autofocus': boolean; /** * If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input. */ 'clearInput': boolean; /** * If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types. */ 'clearOnEdit'?: boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. */ 'debounce': number; /** * If `true`, the user cannot interact with the input. */ 'disabled': boolean; /** * Returns the native `` element used under the hood. */ 'getInputElement': () => Promise; /** * A hint to the browser for which keyboard to display. This attribute applies when the value of the type attribute is `"text"`, `"password"`, `"email"`, or `"url"`. Possible values are: `"verbatim"`, `"latin"`, `"latin-name"`, `"latin-prose"`, `"full-width-latin"`, `"kana"`, `"katakana"`, `"numeric"`, `"tel"`, `"email"`, `"url"`. */ 'inputmode'?: string; /** * The maximum value, which must not be less than its minimum (min attribute) value. */ 'max'?: string; /** * If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter. */ 'maxlength'?: number; /** * The minimum value, which must not be greater than its maximum (max attribute) value. */ 'min'?: string; /** * If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter. */ 'minlength'?: number; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `"email"` or `"file"`, otherwise it is ignored. */ 'multiple'?: boolean; /** * The name of the control, which is submitted with the form data. */ 'name': string; /** * A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. */ 'pattern'?: string; /** * Instructional text that shows before the input has a value. */ 'placeholder'?: string | null; /** * If `true`, the user cannot modify the value. */ 'readonly': boolean; /** * If `true`, the user must fill in a value before submitting a form. */ 'required': boolean; /** * Sets focus on the specified `ion-input`. Use this method instead of the global `input.focus()`. */ 'setFocus': () => void; /** * The initial size of the control. This value is in pixels unless the value of the type attribute is `"text"` or `"password"`, in which case it is an integer number of characters. This attribute applies only when the `type` attribute is set to `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. */ 'size'?: number; /** * If `true`, the element will have its spelling and grammar checked. */ 'spellcheck': boolean; /** * Works with the min and max attributes to limit the increments at which a value can be set. Possible values are: `"any"` or a positive floating point number. */ 'step'?: string; /** * The type of control to display. The default type is text. */ 'type': TextFieldTypes; /** * The value of the input. */ 'value'?: string | null; } interface IonInputAttributes extends StencilHTMLAttributes { /** * If the value of the type attribute is `"file"`, then this attribute will indicate the types of files that the server accepts, otherwise it will be ignored. The value must be a comma-separated list of unique content type specifiers. */ 'accept'?: string; /** * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. */ 'autocapitalize'?: string; /** * Indicates whether the value of the control can be automatically completed by the browser. */ 'autocomplete'?: 'on' | 'off'; /** * Whether auto correction should be enabled when the user is entering/editing the text value. */ 'autocorrect'?: 'on' | 'off'; /** * This Boolean attribute lets you specify that a form control should have input focus when the page loads. */ 'autofocus'?: boolean; /** * If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input. */ 'clearInput'?: boolean; /** * If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types. */ 'clearOnEdit'?: boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. */ 'debounce'?: number; /** * If `true`, the user cannot interact with the input. */ 'disabled'?: boolean; /** * A hint to the browser for which keyboard to display. This attribute applies when the value of the type attribute is `"text"`, `"password"`, `"email"`, or `"url"`. Possible values are: `"verbatim"`, `"latin"`, `"latin-name"`, `"latin-prose"`, `"full-width-latin"`, `"kana"`, `"katakana"`, `"numeric"`, `"tel"`, `"email"`, `"url"`. */ 'inputmode'?: string; /** * The maximum value, which must not be less than its minimum (min attribute) value. */ 'max'?: string; /** * If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter. */ 'maxlength'?: number; /** * The minimum value, which must not be greater than its maximum (max attribute) value. */ 'min'?: string; /** * If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter. */ 'minlength'?: number; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `"email"` or `"file"`, otherwise it is ignored. */ 'multiple'?: boolean; /** * The name of the control, which is submitted with the form data. */ 'name'?: string; /** * Emitted when the input loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the value has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * Emitted when the input has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * Emitted when a keyboard input ocurred. */ 'onIonInput'?: (event: CustomEvent) => void; /** * A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. */ 'pattern'?: string; /** * Instructional text that shows before the input has a value. */ 'placeholder'?: string | null; /** * If `true`, the user cannot modify the value. */ 'readonly'?: boolean; /** * If `true`, the user must fill in a value before submitting a form. */ 'required'?: boolean; /** * The initial size of the control. This value is in pixels unless the value of the type attribute is `"text"` or `"password"`, in which case it is an integer number of characters. This attribute applies only when the `type` attribute is set to `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored. */ 'size'?: number; /** * If `true`, the element will have its spelling and grammar checked. */ 'spellcheck'?: boolean; /** * Works with the min and max attributes to limit the increments at which a value can be set. Possible values are: `"any"` or a positive floating point number. */ 'step'?: string; /** * The type of control to display. The default type is text. */ 'type'?: TextFieldTypes; /** * The value of the input. */ 'value'?: string | null; } interface IonItemDivider { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * When it's set to `true`, the item-divider will stay visible when it reaches the top of the viewport until the next `ion-item-divider` replaces it. This feature relies in `position:sticky`: https://caniuse.com/#feat=css-sticky */ 'sticky': boolean; } interface IonItemDividerAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * When it's set to `true`, the item-divider will stay visible when it reaches the top of the viewport until the next `ion-item-divider` replaces it. This feature relies in `position:sticky`: https://caniuse.com/#feat=css-sticky */ 'sticky'?: boolean; } interface IonItemGroup {} interface IonItemGroupAttributes extends StencilHTMLAttributes {} interface IonItemOption { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the item option. */ 'disabled': boolean; /** * If `true`, the option will expand to take up the available width and cover any other options. */ 'expandable': boolean; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonItemOptionAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the item option. */ 'disabled'?: boolean; /** * If `true`, the option will expand to take up the available width and cover any other options. */ 'expandable'?: boolean; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonItemOptions { 'fireSwipeEvent': () => void; /** * The side the option button should be on. Possible values: `"start"` and `"end"`. If you have multiple `ion-item-options`, a side must be provided for each. */ 'side': Side; } interface IonItemOptionsAttributes extends StencilHTMLAttributes { /** * Emitted when the item has been fully swiped. */ 'onIonSwipe'?: (event: CustomEvent) => void; /** * The side the option button should be on. Possible values: `"start"` and `"end"`. If you have multiple `ion-item-options`, a side must be provided for each. */ 'side'?: Side; } interface IonItemSliding { /** * Close the sliding item. Items can also be closed from the [List](../../list/List). */ 'close': () => Promise; /** * Close all of the sliding items in the list. Items can also be closed from the [List](../../list/List). */ 'closeOpened': () => Promise; /** * If `true`, the user cannot interact with the sliding-item. */ 'disabled': boolean; /** * Get the amount the item is open in pixels. */ 'getOpenAmount': () => Promise; /** * Get the ratio of the open amount of the item compared to the width of the options. If the number returned is positive, then the options on the right side are open. If the number returned is negative, then the options on the left side are open. If the absolute value of the number is greater than 1, the item is open more than the width of the options. */ 'getSlidingRatio': () => Promise; } interface IonItemSlidingAttributes extends StencilHTMLAttributes { /** * If `true`, the user cannot interact with the sliding-item. */ 'disabled'?: boolean; /** * Emitted when the sliding position changes. */ 'onIonDrag'?: (event: CustomEvent) => void; } interface IonItem { /** * If `true`, a button tag will be rendered and the item will be tappable. */ 'button': boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, a detail arrow will appear on the item. Defaults to `false` unless the `mode` is `ios` and an `href`, `onclick` or `button` property is present. */ 'detail'?: boolean; /** * The icon to use when `detail` is set to `true`. */ 'detailIcon': string; /** * If `true`, the user cannot interact with the item. */ 'disabled': boolean; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * How the bottom border should be displayed on the item. */ 'lines'?: 'full' | 'inset' | 'none'; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection': RouterDirection; /** * The type of the button. Only used when an `onclick` or `button` property is present. */ 'type': 'submit' | 'reset' | 'button'; } interface IonItemAttributes extends StencilHTMLAttributes { /** * If `true`, a button tag will be rendered and the item will be tappable. */ 'button'?: boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, a detail arrow will appear on the item. Defaults to `false` unless the `mode` is `ios` and an `href`, `onclick` or `button` property is present. */ 'detail'?: boolean; /** * The icon to use when `detail` is set to `true`. */ 'detailIcon'?: string; /** * If `true`, the user cannot interact with the item. */ 'disabled'?: boolean; /** * Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered. */ 'href'?: string; /** * How the bottom border should be displayed on the item. */ 'lines'?: 'full' | 'inset' | 'none'; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * When using a router, it specifies the transition direction when navigating to another page using `href`. */ 'routerDirection'?: RouterDirection; /** * The type of the button. Only used when an `onclick` or `button` property is present. */ 'type'?: 'submit' | 'reset' | 'button'; } interface IonLabel { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The position determines where and how the label behaves inside an item. */ 'position'?: 'fixed' | 'stacked' | 'floating'; } interface IonLabelAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * The position determines where and how the label behaves inside an item. */ 'position'?: 'fixed' | 'stacked' | 'floating'; } interface IonListHeader { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonListHeaderAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonList { /** * If `ion-item-sliding` are used inside the list, this method closes any open sliding item. Returns `true` if an actual `ion-item-sliding` is closed. */ 'closeSlidingItems': () => Promise; /** * If `true`, the list will have margin around it and rounded corners. */ 'inset': boolean; /** * How the bottom border should be displayed on all items. */ 'lines'?: 'full' | 'inset' | 'none'; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonListAttributes extends StencilHTMLAttributes { /** * If `true`, the list will have margin around it and rounded corners. */ 'inset'?: boolean; /** * How the bottom border should be displayed on all items. */ 'lines'?: 'full' | 'inset' | 'none'; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonLoadingController { /** * Create a loading overlay with loading options. */ 'create': (opts?: LoadingOptions | undefined) => Promise; /** * Dismiss the open loading overlay. */ 'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise; /** * Get the most recently opened loading overlay. */ 'getTop': () => Promise; } interface IonLoadingControllerAttributes extends StencilHTMLAttributes {} interface IonLoading { /** * If `true`, the loading indicator will animate. */ 'animated': boolean; /** * If `true`, the loading indicator will be dismissed when the backdrop is clicked. */ 'backdropDismiss': boolean; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Dismiss the loading overlay after it has been presented. */ 'dismiss': (data?: any, role?: string | undefined) => Promise; /** * Number of milliseconds to wait before dismissing the loading indicator. */ 'duration': number; /** * Animation to use when the loading indicator is presented. */ 'enterAnimation'?: AnimationBuilder; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose': boolean; /** * Animation to use when the loading indicator is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * Optional text content to display in the loading indicator. */ 'message'?: string; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Returns a promise that resolves when the loading did dismiss. */ 'onDidDismiss': () => Promise>; /** * Returns a promise that resolves when the loading will dismiss. */ 'onWillDismiss': () => Promise>; 'overlayIndex': number; /** * Present the loading overlay after it has been created. */ 'present': () => Promise; /** * If `true`, a backdrop will be displayed behind the loading indicator. */ 'showBackdrop': boolean; /** * The name of the spinner to display. */ 'spinner'?: SpinnerTypes | null; /** * If `true`, the loading indicator will be translucent. */ 'translucent': boolean; } interface IonLoadingAttributes extends StencilHTMLAttributes { /** * If `true`, the loading indicator will animate. */ 'animated'?: boolean; /** * If `true`, the loading indicator will be dismissed when the backdrop is clicked. */ 'backdropDismiss'?: boolean; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Number of milliseconds to wait before dismissing the loading indicator. */ 'duration'?: number; /** * Animation to use when the loading indicator is presented. */ 'enterAnimation'?: AnimationBuilder; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose'?: boolean; /** * Animation to use when the loading indicator is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * Optional text content to display in the loading indicator. */ 'message'?: string; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted after the loading has dismissed. */ 'onIonLoadingDidDismiss'?: (event: CustomEvent) => void; /** * Emitted after the loading has presented. */ 'onIonLoadingDidPresent'?: (event: CustomEvent) => void; /** * Emitted before the loading has dismissed. */ 'onIonLoadingWillDismiss'?: (event: CustomEvent) => void; /** * Emitted before the loading has presented. */ 'onIonLoadingWillPresent'?: (event: CustomEvent) => void; /** * If `true`, a backdrop will be displayed behind the loading indicator. */ 'showBackdrop'?: boolean; /** * The name of the spinner to display. */ 'spinner'?: SpinnerTypes | null; /** * If `true`, the loading indicator will be translucent. */ 'translucent'?: boolean; } interface IonMenuButton { /** * Automatically hides the menu button when the corresponding menu is not active */ 'autoHide': boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle */ 'menu'?: string; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonMenuButtonAttributes extends StencilHTMLAttributes { /** * Automatically hides the menu button when the corresponding menu is not active */ 'autoHide'?: boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle */ 'menu'?: string; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonMenuController { '_getInstance': () => Promise; /** * Close the menu. If no menu is specified, then it will close any menu that is open. If a menu is specified, it will close that menu. */ 'close': (menuId?: string | null | undefined) => Promise; /** * 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. */ 'enable': (shouldEnable: boolean, menuId?: string | null | undefined) => Promise; /** * Used to get a menu instance. If a menu is not provided then it will return the first menu found. If the specified menu is `start` or `end`, then it will return the enabled menu on that side. Otherwise, it will try to find the menu using the menu's `id` property. If a menu is not found then it will return `null`. */ 'get': (menuId?: string | null | undefined) => Promise; /** * Returns an array of all menu instances. */ 'getMenus': () => Promise; /** * Returns the instance of the menu already opened, otherwise `null`. */ 'getOpen': () => Promise; /** * Returns `true` if any menu is currently animating. */ 'isAnimating': () => Promise; /** * Returns `true` if the specified menu is enabled. */ 'isEnabled': (menuId?: string | null | undefined) => Promise; /** * Returns `true` if the specified menu is open. If the menu is not specified, it will return `true` if any menu is currently open. */ 'isOpen': (menuId?: string | null | undefined) => Promise; /** * Open the menu. */ 'open': (menuId?: string | null | undefined) => Promise; /** * Registers a new animation that can be used in any `ion-menu`. ``` * * ``` */ 'registerAnimation': (name: string, animation: AnimationBuilder) => void; /** * Used to enable or disable the ability to swipe open the menu. */ 'swipeGesture': (shouldEnable: boolean, menuId?: string | null | undefined) => Promise; /** * Toggle the menu. If it's closed, it will open, and if opened, it will close. */ 'toggle': (menuId?: string | null | undefined) => Promise; } interface IonMenuControllerAttributes extends StencilHTMLAttributes {} interface IonMenuToggle { /** * Automatically hides the content when the corresponding menu is not active. By default, it's `true`. Change it to `false` in order to keep `ion-menu-toggle` always visible regardless the state of the menu. */ 'autoHide': boolean; /** * Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle. If this property is not used, `ion-menu-toggle` will toggle the first menu that is active. */ 'menu'?: string; } interface IonMenuToggleAttributes extends StencilHTMLAttributes { /** * Automatically hides the content when the corresponding menu is not active. By default, it's `true`. Change it to `false` in order to keep `ion-menu-toggle` always visible regardless the state of the menu. */ 'autoHide'?: boolean; /** * Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle. If this property is not used, `ion-menu-toggle` will toggle the first menu that is active. */ 'menu'?: string; } interface IonMenu { /** * Closes the menu. If the menu is already closed or it can't be closed, it returns `false`. */ 'close': (animated?: boolean) => Promise; /** * The content's id the menu should use. */ 'contentId'?: string; /** * If `true`, the menu is disabled. */ 'disabled': boolean; /** * Returns `true` is the menu is active. A menu is active when it can be opened or closed, meaning it's enabled and it's not part of a `ion-split-pane`. */ 'isActive': () => Promise; /** * Returns `true` is the menu is open. */ 'isOpen': () => Promise; /** * The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered. */ 'maxEdgeStart': number; /** * An id for the menu. */ 'menuId'?: string; /** * Opens the menu. If the menu is already open or it can't be opened, it returns `false`. */ 'open': (animated?: boolean) => Promise; /** * Opens or closes the button. If the operation can't be completed successfully, it returns `false`. */ 'setOpen': (shouldOpen: boolean, animated?: boolean) => Promise; /** * Which side of the view the menu should be placed. */ 'side': Side; /** * If `true`, swiping the menu is enabled. */ 'swipeGesture': boolean; /** * Toggles the menu. If the menu is already open, it will try to close, otherwise it will try to open it. If the operation can't be completed successfully, it returns `false`. */ 'toggle': (animated?: boolean) => Promise; /** * The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`. */ 'type'?: string; } interface IonMenuAttributes extends StencilHTMLAttributes { /** * The content's id the menu should use. */ 'contentId'?: string; /** * If `true`, the menu is disabled. */ 'disabled'?: boolean; /** * The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered. */ 'maxEdgeStart'?: number; /** * An id for the menu. */ 'menuId'?: string; /** * Emitted when the menu is closed. */ 'onIonDidClose'?: (event: CustomEvent) => void; /** * Emitted when the menu is open. */ 'onIonDidOpen'?: (event: CustomEvent) => void; /** * Emitted when the menu is about to be closed. */ 'onIonWillClose'?: (event: CustomEvent) => void; /** * Emitted when the menu is about to be opened. */ 'onIonWillOpen'?: (event: CustomEvent) => void; /** * Which side of the view the menu should be placed. */ 'side'?: Side; /** * If `true`, swiping the menu is enabled. */ 'swipeGesture'?: boolean; /** * The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`. */ 'type'?: string; } interface IonModalController { /** * Create a modal overlay with modal options. */ 'create': (opts: ModalOptions) => Promise; /** * Dismiss the open modal overlay. */ 'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise; /** * Get the most recently opened modal overlay. */ 'getTop': () => Promise; } interface IonModalControllerAttributes extends StencilHTMLAttributes {} interface IonModal { /** * If `true`, the modal will animate. */ 'animated': boolean; /** * If `true`, the modal will be dismissed when the backdrop is clicked. */ 'backdropDismiss': boolean; /** * The component to display inside of the modal. */ 'component': ComponentRef; /** * The data to pass to the modal component. */ 'componentProps'?: ComponentProps; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; 'delegate'?: FrameworkDelegate; /** * Dismiss the modal overlay after it has been presented. */ 'dismiss': (data?: any, role?: string | undefined) => Promise; /** * Animation to use when the modal is presented. */ 'enterAnimation'?: AnimationBuilder; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose': boolean; /** * Animation to use when the modal is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Returns a promise that resolves when the modal did dismiss. */ 'onDidDismiss': () => Promise>; /** * Returns a promise that resolves when the modal will dismiss. */ 'onWillDismiss': () => Promise>; 'overlayIndex': number; /** * Present the modal overlay after it has been created. */ 'present': () => Promise; /** * If `true`, a backdrop will be displayed behind the modal. */ 'showBackdrop': boolean; } interface IonModalAttributes extends StencilHTMLAttributes { /** * If `true`, the modal will animate. */ 'animated'?: boolean; /** * If `true`, the modal will be dismissed when the backdrop is clicked. */ 'backdropDismiss'?: boolean; /** * The component to display inside of the modal. */ 'component': ComponentRef; /** * The data to pass to the modal component. */ 'componentProps'?: ComponentProps; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Animation to use when the modal is presented. */ 'enterAnimation'?: AnimationBuilder; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose'?: boolean; /** * Animation to use when the modal is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted after the modal has dismissed. */ 'onIonModalDidDismiss'?: (event: CustomEvent) => void; /** * Emitted after the modal has presented. */ 'onIonModalDidPresent'?: (event: CustomEvent) => void; /** * Emitted before the modal has dismissed. */ 'onIonModalWillDismiss'?: (event: CustomEvent) => void; /** * Emitted before the modal has presented. */ 'onIonModalWillPresent'?: (event: CustomEvent) => void; /** * If `true`, a backdrop will be displayed behind the modal. */ 'showBackdrop'?: boolean; } interface IonNavPop {} interface IonNavPopAttributes extends StencilHTMLAttributes {} interface IonNavPush { /** * Component to navigate to */ 'component'?: NavComponent; /** * Data you want to pass to the component as props */ 'componentProps'?: ComponentProps; } interface IonNavPushAttributes extends StencilHTMLAttributes { /** * Component to navigate to */ 'component'?: NavComponent; /** * Data you want to pass to the component as props */ 'componentProps'?: ComponentProps; } interface IonNavSetRoot { /** * Component you want to make root for the navigation stack */ 'component'?: NavComponent; /** * Data you want to pass to the component as props */ 'componentProps'?: ComponentProps; } interface IonNavSetRootAttributes extends StencilHTMLAttributes { /** * Component you want to make root for the navigation stack */ 'component'?: NavComponent; /** * Data you want to pass to the component as props */ 'componentProps'?: ComponentProps; } interface IonNav { /** * If `true`, the nav should animate the transition of components. */ 'animated': boolean; /** * By default `ion-nav` animates transition between pages based in the mode (ios or material design). However, this property allows to create custom transition using `AnimateBuilder` functions. */ 'animation'?: AnimationBuilder; /** * Returns `true` or false if the current view can go back */ 'canGoBack': (view?: ViewController | undefined) => Promise; 'delegate'?: FrameworkDelegate; /** * Gets the active view */ 'getActive': () => Promise; /** * Returns the view at the index */ 'getByIndex': (index: number) => Promise; /** * Gets the previous view */ 'getPrevious': (view?: ViewController | undefined) => Promise; 'getRouteId': () => Promise; /** * Inserts a component into the nav stack at the specified index. This is useful if you need to add a component at any point in your navigation stack. */ 'insert': (insertIndex: number, component: T, componentProps?: ComponentProps | null | undefined, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Inserts an array of components into the nav stack at the specified index. The last component in the array will become instantiated as a view, and animate in to become the active view. */ 'insertPages': (insertIndex: number, insertComponents: NavComponent[], opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Call to navigate back from a current component. Similar to push(), you can also pass navigation options. */ 'pop': (opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Pop to a specific index in the navigation stack */ 'popTo': (indexOrViewCtrl: number | ViewController, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Navigate back to the root of the stack, no matter how far back that is. */ 'popToRoot': (opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Push a new component onto the current navigation stack. Pass any additional information along as an object. This additional information is accessible through NavParams */ 'push': (component: T, componentProps?: ComponentProps | null | undefined, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Removes a page from the nav stack at the specified index. */ 'removeIndex': (startIndex: number, removeCount?: number, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Root NavComponent to load */ 'root'?: NavComponent; /** * Any parameters for the root component */ 'rootParams'?: ComponentProps; /** * Set the views of the current navigation stack and navigate to the last view. By default animations are disabled, but they can be enabled by passing options to the navigation controller.You can also pass any navigation params to the individual pages in the array. */ 'setPages': (views: any[], opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; /** * Set the root for the current navigation stack. */ 'setRoot': (component: T, componentProps?: ComponentProps | null | undefined, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise; 'setRouteId': (id: string, params: { [key: string]: any; } | undefined, direction: RouterDirection) => Promise; /** * If the nav component should allow for swipe-to-go-back. */ 'swipeGesture'?: boolean; } interface IonNavAttributes extends StencilHTMLAttributes { /** * If `true`, the nav should animate the transition of components. */ 'animated'?: boolean; /** * By default `ion-nav` animates transition between pages based in the mode (ios or material design). However, this property allows to create custom transition using `AnimateBuilder` functions. */ 'animation'?: AnimationBuilder; /** * Event fired when the nav has changed components */ 'onIonNavDidChange'?: (event: CustomEvent) => void; /** * Event fired when the nav will components */ 'onIonNavWillChange'?: (event: CustomEvent) => void; /** * Root NavComponent to load */ 'root'?: NavComponent; /** * Any parameters for the root component */ 'rootParams'?: ComponentProps; /** * If the nav component should allow for swipe-to-go-back. */ 'swipeGesture'?: boolean; } interface IonNote { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonNoteAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonPickerColumn { /** * Picker column data */ 'col': PickerColumn; } interface IonPickerColumnAttributes extends StencilHTMLAttributes { /** * Picker column data */ 'col': PickerColumn; } interface IonPickerController { /** * Create a picker overlay with picker options. */ 'create': (opts: PickerOptions) => Promise; /** * Dismiss the open picker overlay. */ 'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise; /** * Get the most recently opened picker overlay. */ 'getTop': () => Promise; } interface IonPickerControllerAttributes extends StencilHTMLAttributes {} interface IonPicker { /** * If `true`, the picker will animate. */ 'animated': boolean; /** * If `true`, the picker will be dismissed when the backdrop is clicked. */ 'backdropDismiss': boolean; /** * Array of buttons to be displayed at the top of the picker. */ 'buttons': PickerButton[]; /** * Array of columns to be displayed in the picker. */ 'columns': PickerColumn[]; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Dismiss the picker overlay after it has been presented. */ 'dismiss': (data?: any, role?: string | undefined) => Promise; /** * Number of milliseconds to wait before dismissing the picker. */ 'duration': number; /** * Animation to use when the picker is presented. */ 'enterAnimation'?: AnimationBuilder; /** * Returns the column the matches the specified name */ 'getColumn': (name: string) => Promise; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose': boolean; /** * Animation to use when the picker is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Returns a promise that resolves when the picker did dismiss. */ 'onDidDismiss': () => Promise>; /** * Returns a promise that resolves when the picker will dismiss. */ 'onWillDismiss': () => Promise>; 'overlayIndex': number; /** * Present the picker overlay after it has been created. */ 'present': () => Promise; /** * If `true`, a backdrop will be displayed behind the picker. */ 'showBackdrop': boolean; } interface IonPickerAttributes extends StencilHTMLAttributes { /** * If `true`, the picker will animate. */ 'animated'?: boolean; /** * If `true`, the picker will be dismissed when the backdrop is clicked. */ 'backdropDismiss'?: boolean; /** * Array of buttons to be displayed at the top of the picker. */ 'buttons'?: PickerButton[]; /** * Array of columns to be displayed in the picker. */ 'columns'?: PickerColumn[]; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Number of milliseconds to wait before dismissing the picker. */ 'duration'?: number; /** * Animation to use when the picker is presented. */ 'enterAnimation'?: AnimationBuilder; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose'?: boolean; /** * Animation to use when the picker is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted after the picker has dismissed. */ 'onIonPickerDidDismiss'?: (event: CustomEvent) => void; /** * Emitted after the picker has presented. */ 'onIonPickerDidPresent'?: (event: CustomEvent) => void; /** * Emitted before the picker has dismissed. */ 'onIonPickerWillDismiss'?: (event: CustomEvent) => void; /** * Emitted before the picker has presented. */ 'onIonPickerWillPresent'?: (event: CustomEvent) => void; /** * If `true`, a backdrop will be displayed behind the picker. */ 'showBackdrop'?: boolean; } interface IonPopoverController { /** * Create a popover overlay with popover options. */ 'create': (opts: PopoverOptions) => Promise; /** * Dismiss the open popover overlay. */ 'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise; /** * Get the most recently opened popover overlay. */ 'getTop': () => Promise; } interface IonPopoverControllerAttributes extends StencilHTMLAttributes {} interface IonPopover { /** * If `true`, the popover will animate. */ 'animated': boolean; /** * If `true`, the popover will be dismissed when the backdrop is clicked. */ 'backdropDismiss': boolean; /** * The component to display inside of the popover. */ 'component': ComponentRef; /** * The data to pass to the popover component. */ 'componentProps'?: ComponentProps; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; 'delegate'?: FrameworkDelegate; /** * Dismiss the popover overlay after it has been presented. */ 'dismiss': (data?: any, role?: string | undefined) => Promise; /** * Animation to use when the popover is presented. */ 'enterAnimation'?: AnimationBuilder; /** * The event to pass to the popover animation. */ 'event': any; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose': boolean; /** * Animation to use when the popover is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Returns a promise that resolves when the popover did dismiss. */ 'onDidDismiss': () => Promise>; /** * Returns a promise that resolves when the popover will dismiss. */ 'onWillDismiss': () => Promise>; 'overlayIndex': number; /** * Present the popover overlay after it has been created. */ 'present': () => Promise; /** * If `true`, a backdrop will be displayed behind the popover. */ 'showBackdrop': boolean; /** * If `true`, the popover will be translucent. */ 'translucent': boolean; } interface IonPopoverAttributes extends StencilHTMLAttributes { /** * If `true`, the popover will animate. */ 'animated'?: boolean; /** * If `true`, the popover will be dismissed when the backdrop is clicked. */ 'backdropDismiss'?: boolean; /** * The component to display inside of the popover. */ 'component': ComponentRef; /** * The data to pass to the popover component. */ 'componentProps'?: ComponentProps; /** * Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. */ 'cssClass'?: string | string[]; /** * Animation to use when the popover is presented. */ 'enterAnimation'?: AnimationBuilder; /** * The event to pass to the popover animation. */ 'event'?: any; /** * If `true`, the keyboard will be automatically dismissed when the overlay is presented. */ 'keyboardClose'?: boolean; /** * Animation to use when the popover is dismissed. */ 'leaveAnimation'?: AnimationBuilder; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted after the popover has dismissed. */ 'onIonPopoverDidDismiss'?: (event: CustomEvent) => void; /** * Emitted after the popover has presented. */ 'onIonPopoverDidPresent'?: (event: CustomEvent) => void; /** * Emitted before the popover has dismissed. */ 'onIonPopoverWillDismiss'?: (event: CustomEvent) => void; /** * Emitted before the popover has presented. */ 'onIonPopoverWillPresent'?: (event: CustomEvent) => void; /** * If `true`, a backdrop will be displayed behind the popover. */ 'showBackdrop'?: boolean; /** * If `true`, the popover will be translucent. */ 'translucent'?: boolean; } interface IonProgressBar { /** * If the buffer and value are smaller than 1, the buffer circles will show. The buffer should be between [0, 1]. */ 'buffer': number; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * If true, reverse the progress bar direction. */ 'reversed': boolean; /** * The state of the progress bar, based on if the time the process takes is known or not. Default options are: `"determinate"` (no animation), `"indeterminate"` (animate from left to right). */ 'type': 'determinate' | 'indeterminate'; /** * The value determines how much of the active bar should display when the `type` is `"determinate"`. The value should be between [0, 1]. */ 'value': number; } interface IonProgressBarAttributes extends StencilHTMLAttributes { /** * If the buffer and value are smaller than 1, the buffer circles will show. The buffer should be between [0, 1]. */ 'buffer'?: number; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * If true, reverse the progress bar direction. */ 'reversed'?: boolean; /** * The state of the progress bar, based on if the time the process takes is known or not. Default options are: `"determinate"` (no animation), `"indeterminate"` (animate from left to right). */ 'type'?: 'determinate' | 'indeterminate'; /** * The value determines how much of the active bar should display when the `type` is `"determinate"`. The value should be between [0, 1]. */ 'value'?: number; } interface IonRadioGroup { /** * If `true`, the radios can be deselected. */ 'allowEmptySelection': boolean; /** * The name of the control, which is submitted with the form data. */ 'name': string; /** * the value of the radio group. */ 'value'?: any | null; } interface IonRadioGroupAttributes extends StencilHTMLAttributes { /** * If `true`, the radios can be deselected. */ 'allowEmptySelection'?: boolean; /** * The name of the control, which is submitted with the form data. */ 'name'?: string; /** * Emitted when the value has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * the value of the radio group. */ 'value'?: any | null; } interface IonRadio { /** * If `true`, the radio is selected. */ 'checked': boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the radio. */ 'disabled': boolean; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The name of the control, which is submitted with the form data. */ 'name': string; /** * the value of the radio. */ 'value'?: any | null; } interface IonRadioAttributes extends StencilHTMLAttributes { /** * If `true`, the radio is selected. */ 'checked'?: boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the radio. */ 'disabled'?: boolean; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * The name of the control, which is submitted with the form data. */ 'name'?: string; /** * Emitted when the radio button loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the radio button has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * Emitted when the radio button is selected. */ 'onIonSelect'?: (event: CustomEvent) => void; /** * the value of the radio. */ 'value'?: any | null; } interface IonRange { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * How long, in milliseconds, to wait to trigger the `ionChange` event after each change in the range value. */ 'debounce': number; /** * If `true`, the user cannot interact with the range. */ 'disabled': boolean; /** * Show two knobs. */ 'dualKnobs': boolean; /** * Maximum integer value of the range. */ 'max': number; /** * Minimum integer value of the range. */ 'min': number; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The name of the control, which is submitted with the form data. */ 'name': string; /** * If `true`, a pin with integer value is shown when the knob is pressed. */ 'pin': boolean; /** * If `true`, the knob snaps to tick marks evenly spaced based on the step property value. */ 'snaps': boolean; /** * Specifies the value granularity. */ 'step': number; /** * the value of the range. */ 'value': RangeValue; } interface IonRangeAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * How long, in milliseconds, to wait to trigger the `ionChange` event after each change in the range value. */ 'debounce'?: number; /** * If `true`, the user cannot interact with the range. */ 'disabled'?: boolean; /** * Show two knobs. */ 'dualKnobs'?: boolean; /** * Maximum integer value of the range. */ 'max'?: number; /** * Minimum integer value of the range. */ 'min'?: number; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * The name of the control, which is submitted with the form data. */ 'name'?: string; /** * Emitted when the range loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the value property has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * Emitted when the range has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * If `true`, a pin with integer value is shown when the knob is pressed. */ 'pin'?: boolean; /** * If `true`, the knob snaps to tick marks evenly spaced based on the step property value. */ 'snaps'?: boolean; /** * Specifies the value granularity. */ 'step'?: number; /** * the value of the range. */ 'value'?: RangeValue; } interface IonRefresherContent { /** * A static icon to display when you begin to pull down */ 'pullingIcon'?: string | null; /** * The text you want to display when you begin to pull down */ 'pullingText'?: string; /** * An animated SVG spinner that shows when refreshing begins */ 'refreshingSpinner'?: SpinnerTypes | null; /** * The text you want to display when performing a refresh */ 'refreshingText'?: string; } interface IonRefresherContentAttributes extends StencilHTMLAttributes { /** * A static icon to display when you begin to pull down */ 'pullingIcon'?: string | null; /** * The text you want to display when you begin to pull down */ 'pullingText'?: string; /** * An animated SVG spinner that shows when refreshing begins */ 'refreshingSpinner'?: SpinnerTypes | null; /** * The text you want to display when performing a refresh */ 'refreshingText'?: string; } interface IonRefresher { /** * Changes the refresher's state from `refreshing` to `cancelling`. */ 'cancel': () => void; /** * Time it takes to close the refresher. */ 'closeDuration': string; /** * Call `complete()` when your async operation has completed. For example, the `refreshing` state is while the app is performing an asynchronous operation, such as receiving more data from an AJAX request. Once the data has been received, you then call this method to signify that the refreshing has completed and to close the refresher. This method also changes the refresher's state from `refreshing` to `completing`. */ 'complete': () => void; /** * If `true`, the refresher will be hidden. */ 'disabled': boolean; /** * A number representing how far down the user has pulled. The number `0` represents the user hasn't pulled down at all. The number `1`, and anything greater than `1`, represents that the user has pulled far enough down that when they let go then the refresh will happen. If they let go and the number is less than `1`, then the refresh will not happen, and the content will return to it's original position. */ 'getProgress': () => Promise; /** * The maximum distance of the pull until the refresher will automatically go into the `refreshing` state. Defaults to the result of `pullMin + 60`. */ 'pullMax': number; /** * The minimum distance the user must pull down until the refresher will go into the `refreshing` state. */ 'pullMin': number; /** * Time it takes the refresher to to snap back to the `refreshing` state. */ 'snapbackDuration': string; } interface IonRefresherAttributes extends StencilHTMLAttributes { /** * Time it takes to close the refresher. */ 'closeDuration'?: string; /** * If `true`, the refresher will be hidden. */ 'disabled'?: boolean; /** * Emitted while the user is pulling down the content and exposing the refresher. */ 'onIonPull'?: (event: CustomEvent) => void; /** * Emitted when the user lets go of the content and has pulled down further than the `pullMin` or pulls the content down and exceeds the pullMax. Updates the refresher state to `refreshing`. The `complete()` method should be called when the async operation has completed. */ 'onIonRefresh'?: (event: CustomEvent) => void; /** * Emitted when the user begins to start pulling down. */ 'onIonStart'?: (event: CustomEvent) => void; /** * The maximum distance of the pull until the refresher will automatically go into the `refreshing` state. Defaults to the result of `pullMin + 60`. */ 'pullMax'?: number; /** * The minimum distance the user must pull down until the refresher will go into the `refreshing` state. */ 'pullMin'?: number; /** * Time it takes the refresher to to snap back to the `refreshing` state. */ 'snapbackDuration'?: string; } interface IonReorderGroup { /** * This method must be called once the `ionItemReorder` event is handled in order to complete the reorder operation. */ 'complete': (listOrReorder?: boolean | any[] | undefined) => Promise; /** * If `true`, the reorder will be hidden. */ 'disabled': boolean; } interface IonReorderGroupAttributes extends StencilHTMLAttributes { /** * If `true`, the reorder will be hidden. */ 'disabled'?: boolean; /** * Event that needs to be listen to in order to respond to reorder action. `ion-reorder-group` uses this event to delegate to the user the reordering of data array. The complete() method exposed as */ 'onIonItemReorder'?: (event: CustomEvent) => void; } interface IonReorder {} interface IonReorderAttributes extends StencilHTMLAttributes {} interface IonRippleEffect { /** * Adds the ripple effect to the parent element */ 'addRipple': (pageX: number, pageY: number) => Promise<() => void>; /** * Sets the type of ripple-effect: - `bounded`: the ripple effect expands from the user's click position - `unbounded`: the ripple effect expands from the center of the button and overflows the container. NOTE: Surfaces for bounded ripples should have the overflow property set to hidden, while surfaces for unbounded ripples should have it set to visible. */ 'type': 'bounded' | 'unbounded'; } interface IonRippleEffectAttributes extends StencilHTMLAttributes { /** * Sets the type of ripple-effect: - `bounded`: the ripple effect expands from the user's click position - `unbounded`: the ripple effect expands from the center of the button and overflows the container. NOTE: Surfaces for bounded ripples should have the overflow property set to hidden, while surfaces for unbounded ripples should have it set to visible. */ 'type'?: 'bounded' | 'unbounded'; } interface IonRouteRedirect { /** * A redirect route, redirects "from" a URL "to" another URL. This property is that "from" URL. It needs to be an exact match of the navigated URL in order to apply. The path specified in this value is always an absolute path, even if the initial `/` slash is not specified. */ 'from': string; /** * A redirect route, redirects "from" a URL "to" another URL. This property is that "to" URL. When the defined `ion-route-redirect` rule matches, the router will redirect to the path specified in this property. The value of this property is always an absolute path inside the scope of routes defined in `ion-router` it can't be used with another router or to perform a redirection to a different domain. Note that this is a virtual redirect, it will not cause a real browser refresh, again, it's a redirect inside the context of ion-router. When this property is not specified or his value is `undefined` the whole redirect route is noop, even if the "from" value matches. */ 'to': string | undefined | null; } interface IonRouteRedirectAttributes extends StencilHTMLAttributes { /** * A redirect route, redirects "from" a URL "to" another URL. This property is that "from" URL. It needs to be an exact match of the navigated URL in order to apply. The path specified in this value is always an absolute path, even if the initial `/` slash is not specified. */ 'from': string; /** * Internal event that fires when any value of this rule is added/removed from the DOM, or any of his public properties changes. `ion-router` captures this event in order to update his internal registry of router rules. */ 'onIonRouteRedirectChanged'?: (event: CustomEvent) => void; /** * A redirect route, redirects "from" a URL "to" another URL. This property is that "to" URL. When the defined `ion-route-redirect` rule matches, the router will redirect to the path specified in this property. The value of this property is always an absolute path inside the scope of routes defined in `ion-router` it can't be used with another router or to perform a redirection to a different domain. Note that this is a virtual redirect, it will not cause a real browser refresh, again, it's a redirect inside the context of ion-router. When this property is not specified or his value is `undefined` the whole redirect route is noop, even if the "from" value matches. */ 'to': string | undefined | null; } interface IonRoute { /** * Name of the component to load/select in the navigation outlet (`ion-tabs`, `ion-nav`) when the route matches. The value of this property is not always the tagname of the component to load, in `ion-tabs` it actually refers to the name of the `ion-tab` to select. */ 'component': string; /** * A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed to the defined component when rendered. */ 'componentProps'?: {[key: string]: any}; /** * Relative path that needs to match in order for this route to apply. Accepts paths similar to expressjs so that you can define parameters in the url /foo/:bar where bar would be available in incoming props. */ 'url': string; } interface IonRouteAttributes extends StencilHTMLAttributes { /** * Name of the component to load/select in the navigation outlet (`ion-tabs`, `ion-nav`) when the route matches. The value of this property is not always the tagname of the component to load, in `ion-tabs` it actually refers to the name of the `ion-tab` to select. */ 'component': string; /** * A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed to the defined component when rendered. */ 'componentProps'?: {[key: string]: any}; /** * Used internally by `ion-router` to know when this route did change. */ 'onIonRouteDataChanged'?: (event: CustomEvent) => void; /** * Relative path that needs to match in order for this route to apply. Accepts paths similar to expressjs so that you can define parameters in the url /foo/:bar where bar would be available in incoming props. */ 'url'?: string; } interface IonRouterOutlet { /** * If `true`, the router-outlet should animate the transition of components. */ 'animated': boolean; /** * By default `ion-nav` animates transition between pages based in the mode (ios or material design). However, this property allows to create custom transition using `AnimateBuilder` functions. */ 'animation'?: AnimationBuilder; 'commit': (enteringEl: HTMLElement, leavingEl: HTMLElement | undefined, opts?: RouterOutletOptions | undefined) => Promise; 'delegate'?: FrameworkDelegate; 'getRouteId': () => Promise; 'mode': Mode; 'setRouteId': (id: string, params: { [key: string]: any; } | undefined, direction: RouterDirection) => Promise; 'swipeHandler'?: SwipeGestureHandler; } interface IonRouterOutletAttributes extends StencilHTMLAttributes { /** * If `true`, the router-outlet should animate the transition of components. */ 'animated'?: boolean; /** * By default `ion-nav` animates transition between pages based in the mode (ios or material design). However, this property allows to create custom transition using `AnimateBuilder` functions. */ 'animation'?: AnimationBuilder; } interface IonRouter { /** * Go back to previous page in the window.history. */ 'back': () => Promise; 'navChanged': (direction: RouterDirection) => Promise; 'printDebug': () => void; /** * Navigate to the specified URL. */ 'push': (url: string, direction?: RouterDirection) => Promise; /** * By default `ion-router` will match the routes at the root path ("/"). That can be changed when */ 'root': string; /** * The router can work in two "modes": - With hash: `/index.html#/path/to/page` - Without hash: `/path/to/page` Using one or another might depend in the requirements of your app and/or where it's deployed. Usually "hash-less" navigation works better for SEO and it's more user friendly too, but it might requires additional server-side configuration in order to properly work. On the otherside hash-navigation is much easier to deploy, it even works over the file protocol. By default, this property is `true`, change to `false` to allow hash-less URLs. */ 'useHash': boolean; } interface IonRouterAttributes extends StencilHTMLAttributes { /** * Emitted when the route had changed */ 'onIonRouteDidChange'?: (event: CustomEvent) => void; /** * Event emitted when the route is about to change */ 'onIonRouteWillChange'?: (event: CustomEvent) => void; /** * By default `ion-router` will match the routes at the root path ("/"). That can be changed when */ 'root'?: string; /** * The router can work in two "modes": - With hash: `/index.html#/path/to/page` - Without hash: `/path/to/page` Using one or another might depend in the requirements of your app and/or where it's deployed. Usually "hash-less" navigation works better for SEO and it's more user friendly too, but it might requires additional server-side configuration in order to properly work. On the otherside hash-navigation is much easier to deploy, it even works over the file protocol. By default, this property is `true`, change to `false` to allow hash-less URLs. */ 'useHash'?: boolean; } interface IonRow {} interface IonRowAttributes extends StencilHTMLAttributes {} interface IonSearchbar { /** * If `true`, enable searchbar animation. */ 'animated': boolean; /** * Set the input's autocomplete property. */ 'autocomplete': 'on' | 'off'; /** * Set the input's autocorrect property. */ 'autocorrect': 'on' | 'off'; /** * Set the cancel button icon. Only applies to `md` mode. */ 'cancelButtonIcon': string; /** * Set the the cancel button text. Only applies to `ios` mode. */ 'cancelButtonText': string; /** * Set the clear icon. Defaults to `"close-circle"` for `ios` and `"close"` for `md`. */ 'clearIcon'?: string; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. */ 'debounce': number; /** * Returns the native `` element used under the hood. */ 'getInputElement': () => Promise; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Set the input's placeholder. */ 'placeholder': string; /** * The icon to use as the search icon. */ 'searchIcon': string; /** * Sets focus on the specified `ion-searchbar`. Use this method instead of the global `input.focus()`. */ 'setFocus': () => void; /** * If `true`, show the cancel button. */ 'showCancelButton': boolean; /** * If `true`, enable spellcheck on the input. */ 'spellcheck': boolean; /** * Set the type of the input. */ 'type': 'text' | 'password' | 'email' | 'number' | 'search' | 'tel' | 'url'; /** * the value of the searchbar. */ 'value'?: string | null; } interface IonSearchbarAttributes extends StencilHTMLAttributes { /** * If `true`, enable searchbar animation. */ 'animated'?: boolean; /** * Set the input's autocomplete property. */ 'autocomplete'?: 'on' | 'off'; /** * Set the input's autocorrect property. */ 'autocorrect'?: 'on' | 'off'; /** * Set the cancel button icon. Only applies to `md` mode. */ 'cancelButtonIcon'?: string; /** * Set the the cancel button text. Only applies to `ios` mode. */ 'cancelButtonText'?: string; /** * Set the clear icon. Defaults to `"close-circle"` for `ios` and `"close"` for `md`. */ 'clearIcon'?: string; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. */ 'debounce'?: number; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted when the input loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the cancel button is clicked. */ 'onIonCancel'?: (event: CustomEvent) => void; /** * Emitted when the value has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * Emitted when the clear input button is clicked. */ 'onIonClear'?: (event: CustomEvent) => void; /** * Emitted when the input has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * Emitted when a keyboard input ocurred. */ 'onIonInput'?: (event: CustomEvent) => void; /** * Set the input's placeholder. */ 'placeholder'?: string; /** * The icon to use as the search icon. */ 'searchIcon'?: string; /** * If `true`, show the cancel button. */ 'showCancelButton'?: boolean; /** * If `true`, enable spellcheck on the input. */ 'spellcheck'?: boolean; /** * Set the type of the input. */ 'type'?: 'text' | 'password' | 'email' | 'number' | 'search' | 'tel' | 'url'; /** * the value of the searchbar. */ 'value'?: string | null; } interface IonSegmentButton { /** * If `true`, the segment button is selected. */ 'checked': boolean; /** * If `true`, the user cannot interact with the segment button. */ 'disabled': boolean; /** * Set the layout of the text and icon in the segment. */ 'layout'?: SegmentButtonLayout; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The value of the segment button. */ 'value': string; } interface IonSegmentButtonAttributes extends StencilHTMLAttributes { /** * If `true`, the segment button is selected. */ 'checked'?: boolean; /** * If `true`, the user cannot interact with the segment button. */ 'disabled'?: boolean; /** * Set the layout of the text and icon in the segment. */ 'layout'?: SegmentButtonLayout; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted when the segment button is clicked. */ 'onIonSelect'?: (event: CustomEvent) => void; /** * The value of the segment button. */ 'value'?: string; } interface IonSegment { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the segment. */ 'disabled': boolean; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * If `true`, the segment buttons will overflow and the user can swipe to see them. */ 'scrollable': boolean; /** * the value of the segment. */ 'value'?: string | null; } interface IonSegmentAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * If `true`, the user cannot interact with the segment. */ 'disabled'?: boolean; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted when the value property has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * Emitted when the styles change. */ 'onIonStyle'?: (event: CustomEvent) => void; /** * If `true`, the segment buttons will overflow and the user can swipe to see them. */ 'scrollable'?: boolean; /** * the value of the segment. */ 'value'?: string | null; } interface IonSelectOption { /** * If `true`, the user cannot interact with the select option. */ 'disabled': boolean; /** * If `true`, the element is selected. */ 'selected': boolean; /** * The text value of the option. */ 'value'?: any | null; } interface IonSelectOptionAttributes extends StencilHTMLAttributes { /** * If `true`, the user cannot interact with the select option. */ 'disabled'?: boolean; /** * If `true`, the element is selected. */ 'selected'?: boolean; /** * The text value of the option. */ 'value'?: any | null; } interface IonSelectPopover { /** * Header text for the popover */ 'header'?: string; /** * Text for popover body */ 'message'?: string; /** * Array of options for the popover */ 'options': SelectPopoverOption[]; /** * Subheader text for the popover */ 'subHeader'?: string; } interface IonSelectPopoverAttributes extends StencilHTMLAttributes { /** * Header text for the popover */ 'header'?: string; /** * Text for popover body */ 'message'?: string; /** * Array of options for the popover */ 'options'?: SelectPopoverOption[]; /** * Subheader text for the popover */ 'subHeader'?: string; } interface IonSelect { /** * The text to display on the cancel button. */ 'cancelText': string; /** * If `true`, the user cannot interact with the select. */ 'disabled': boolean; /** * The interface the select should use: `action-sheet`, `popover` or `alert`. */ 'interface': SelectInterface; /** * 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. */ 'interfaceOptions': any; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * If `true`, the select can accept multiple values. */ 'multiple': boolean; /** * The name of the control, which is submitted with the form data. */ 'name': string; /** * The text to display on the ok button. */ 'okText': string; /** * Opens the select overlay, it could be an alert, action-sheet or popover, based in `ion-select` settings. */ 'open': (ev?: UIEvent | undefined) => Promise; /** * The text to display when the select is empty. */ 'placeholder'?: string | null; /** * The text to display instead of the selected option's value. */ 'selectedText'?: string | null; /** * the value of the select. */ 'value'?: any | null; } interface IonSelectAttributes extends StencilHTMLAttributes { /** * The text to display on the cancel button. */ 'cancelText'?: string; /** * If `true`, the user cannot interact with the select. */ 'disabled'?: boolean; /** * The interface the select should use: `action-sheet`, `popover` or `alert`. */ 'interface'?: SelectInterface; /** * 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. */ 'interfaceOptions'?: any; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * If `true`, the select can accept multiple values. */ 'multiple'?: boolean; /** * The name of the control, which is submitted with the form data. */ 'name'?: string; /** * The text to display on the ok button. */ 'okText'?: string; /** * Emitted when the select loses focus. */ 'onIonBlur'?: (event: CustomEvent) => void; /** * Emitted when the selection is cancelled. */ 'onIonCancel'?: (event: CustomEvent) => void; /** * Emitted when the value has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** * Emitted when the select has focus. */ 'onIonFocus'?: (event: CustomEvent) => void; /** * The text to display when the select is empty. */ 'placeholder'?: string | null; /** * The text to display instead of the selected option's value. */ 'selectedText'?: string | null; /** * the value of the select. */ 'value'?: any | null; } interface IonSkeletonText { /** * Width for the element to render at. */ 'width': string; } interface IonSkeletonTextAttributes extends StencilHTMLAttributes { /** * Width for the element to render at. */ 'width'?: string; } interface IonSlide {} interface IonSlideAttributes extends StencilHTMLAttributes {} interface IonSlides { /** * Get the index of the active slide. */ 'getActiveIndex': () => Promise; /** * Get the index of the previous slide. */ 'getPreviousIndex': () => Promise; /** * Get whether or not the current slide is the first slide. */ 'isBeginning': () => Promise; /** * Get whether or not the current slide is the last slide. */ 'isEnd': () => Promise; /** * Get the total number of slides. */ 'length': () => Promise; /** * Lock or unlock the ability to slide to the next slides. */ 'lockSwipeToNext': (shouldLockSwipeToNext: boolean) => Promise; /** * Lock or unlock the ability to slide to the previous slides. */ 'lockSwipeToPrev': (shouldLockSwipeToPrev: boolean) => Promise; /** * Lock or unlock the ability to slide to change slides. */ 'lockSwipes': (shouldLockSwipes: boolean) => Promise; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * Options to pass to the swiper instance. See http://idangero.us/swiper/api/ for valid options */ 'options': any; /** * If `true`, show the pagination. */ 'pager': boolean; /** * If `true`, show the scrollbar. */ 'scrollbar': boolean; /** * Transition to the next slide. */ 'slideNext': (speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise; /** * Transition to the previous slide. */ 'slidePrev': (speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise; /** * Transition to the specified slide. */ 'slideTo': (index: number, speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise; /** * Start auto play. */ 'startAutoplay': () => Promise; /** * Stop auto play. */ 'stopAutoplay': () => Promise; /** * Update the underlying slider implementation. Call this if you've added or removed child slides. */ 'update': () => Promise; /** * Force swiper to update its height (when autoHeight enabled) for the duration equal to 'speed' parameter */ 'updateAutoHeight': (speed?: number | undefined) => Promise; } interface IonSlidesAttributes extends StencilHTMLAttributes { /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * Emitted after the active slide has changed. */ 'onIonSlideDidChange'?: (event: CustomEvent) => void; /** * Emitted when the user double taps on the slide's container. */ 'onIonSlideDoubleTap'?: (event: CustomEvent) => void; /** * Emitted when the slider is actively being moved. */ 'onIonSlideDrag'?: (event: CustomEvent) => void; /** * Emitted when the next slide has ended. */ 'onIonSlideNextEnd'?: (event: CustomEvent) => void; /** * Emitted when the next slide has started. */ 'onIonSlideNextStart'?: (event: CustomEvent) => void; /** * Emitted when the previous slide has ended. */ 'onIonSlidePrevEnd'?: (event: CustomEvent) => void; /** * Emitted when the previous slide has started. */ 'onIonSlidePrevStart'?: (event: CustomEvent) => void; /** * Emitted when the slider is at the last slide. */ 'onIonSlideReachEnd'?: (event: CustomEvent) => void; /** * Emitted when the slider is at its initial position. */ 'onIonSlideReachStart'?: (event: CustomEvent) => void; /** * Emitted when the user taps/clicks on the slide's container. */ 'onIonSlideTap'?: (event: CustomEvent) => void; /** * Emitted when the user releases the touch. */ 'onIonSlideTouchEnd'?: (event: CustomEvent) => void; /** * Emitted when the user first touches the slider. */ 'onIonSlideTouchStart'?: (event: CustomEvent) => void; /** * Emitted when the slide transition has ended. */ 'onIonSlideTransitionEnd'?: (event: CustomEvent) => void; /** * Emitted when the slide transition has started. */ 'onIonSlideTransitionStart'?: (event: CustomEvent) => void; /** * Emitted before the active slide has changed. */ 'onIonSlideWillChange'?: (event: CustomEvent) => void; /** * Emitted after Swiper initialization */ 'onIonSlidesDidLoad'?: (event: CustomEvent) => void; /** * Options to pass to the swiper instance. See http://idangero.us/swiper/api/ for valid options */ 'options'?: any; /** * If `true`, show the pagination. */ 'pager'?: boolean; /** * If `true`, show the scrollbar. */ 'scrollbar'?: boolean; } interface IonSpinner { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Duration of the spinner animation in milliseconds. The default varies based on the spinner. */ 'duration'?: number; /** * The name of the SVG spinner to use. If a name is not provided, the platform's default spinner will be used. */ 'name'?: SpinnerTypes; /** * If `true`, the spinner's animation will be paused. */ 'paused': boolean; } interface IonSpinnerAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * Duration of the spinner animation in milliseconds. The default varies based on the spinner. */ 'duration'?: number; /** * The name of the SVG spinner to use. If a name is not provided, the platform's default spinner will be used. */ 'name'?: SpinnerTypes; /** * If `true`, the spinner's animation will be paused. */ 'paused'?: boolean; } interface IonSplitPane { /** * The content `id` of the split-pane's main content. This property can be used instead of the `[main]` attribute to select the `main` content of the split-pane. ```html * * *
* * ``` */ 'contentId'?: string; /** * If `true`, the split pane will be hidden. */ 'disabled': boolean; /** * When the split-pane should be shown. Can be a CSS media query expression, or a shortcut expression. Can also be a boolean expression. */ 'when': string | boolean; } interface IonSplitPaneAttributes extends StencilHTMLAttributes { /** * The content `id` of the split-pane's main content. This property can be used instead of the `[main]` attribute to select the `main` content of the split-pane. ```html * * *
* * ``` */ 'contentId'?: string; /** * If `true`, the split pane will be hidden. */ 'disabled'?: boolean; /** * Expression to be called when the split-pane visibility has changed */ 'onIonSplitPaneVisible'?: (event: CustomEvent<{visible: boolean}>) => void; /** * When the split-pane should be shown. Can be a CSS media query expression, or a shortcut expression. Can also be a boolean expression. */ 'when'?: string | boolean; } interface IonTabBar { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The selected tab component */ 'selectedTab'?: string; /** * If `true`, the tab bar will be translucent. */ 'translucent': boolean; } interface IonTabBarAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * The selected tab component */ 'selectedTab'?: string; /** * If `true`, the tab bar will be translucent. */ 'translucent'?: boolean; } interface IonTabButton { /** * The selected tab component */ 'disabled': boolean; /** * The URL which will be used as the `href` within this tab's button anchor. */ 'href'?: string; /** * Set the layout of the text and icon in the tab bar. It defaults to `'icon-top'`. */ 'layout'?: TabButtonLayout; /** * The mode determines which platform styles to use. */ 'mode': Mode; /** * The selected tab component */ 'selected': boolean; /** * A tab id must be provided for each `ion-tab`. It's used internally to reference the selected tab or by the router to switch between them. */ 'tab'?: string; } interface IonTabButtonAttributes extends StencilHTMLAttributes { /** * The selected tab component */ 'disabled'?: boolean; /** * The URL which will be used as the `href` within this tab's button anchor. */ 'href'?: string; /** * Set the layout of the text and icon in the tab bar. It defaults to `'icon-top'`. */ 'layout'?: TabButtonLayout; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; /** * The selected tab component */ 'selected'?: boolean; /** * A tab id must be provided for each `ion-tab`. It's used internally to reference the selected tab or by the router to switch between them. */ 'tab'?: string; } interface IonTab { 'active': boolean; /** * The component to display inside of the tab. */ 'component'?: ComponentRef; 'delegate'?: FrameworkDelegate; /** * Set the active component for the tab */ 'setActive': () => Promise; /** * A tab id must be provided for each `ion-tab`. It's used internally to reference the selected tab or by the router to switch between them. */ 'tab': string; } interface IonTabAttributes extends StencilHTMLAttributes { /** * The component to display inside of the tab. */ 'component'?: ComponentRef; /** * A tab id must be provided for each `ion-tab`. It's used internally to reference the selected tab or by the router to switch between them. */ 'tab': string; } interface IonTabs { 'getRouteId': () => Promise; /** * Get the currently selected tab */ 'getSelected': () => Promise; /** * Get the tab element given the tab name */ 'getTab': (tab: string | HTMLIonTabElement) => Promise; /** * Index or the Tab instance, of the tab to select. */ 'select': (tab: string | HTMLIonTabElement) => Promise; 'setRouteId': (id: string) => Promise; 'useRouter': boolean; } interface IonTabsAttributes extends StencilHTMLAttributes { /** * Emitted when the navigation has finished transitioning to a new component. */ 'onIonTabsDidChange'?: (event: CustomEvent<{tab: string}>) => void; /** * Emitted when the navigation is about to transition to a new component. */ 'onIonTabsWillChange'?: (event: CustomEvent<{tab: string}>) => void; } interface IonText { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode': Mode; } interface IonTextAttributes extends StencilHTMLAttributes { /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The mode determines which platform styles to use. */ 'mode'?: Mode; } interface IonTextarea { /** * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. */ 'autocapitalize': string; /** * This Boolean attribute lets you specify that a form control should have input focus when the page loads. */ 'autofocus': boolean; /** * If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `"password"`, `false` for all other types. */ 'clearOnEdit': boolean; /** * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). */ 'color'?: Color; /** * The visible width of the text control, in average character widths. If it is specified, it must be a positive integer. */ 'cols'?: number; /** * Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. */ 'debounce': number; /** * If `true`, the user cannot interact with the textarea. */ 'disabled': boolean; /** * Returns the native `