javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-16 18:17:31 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
ionic-framework/core/src/components.d.ts
Manu MA c982856dba feat(toast): add "color" prop (#16100) 
This commit also refactors ion-toast, so it uses shadow-dom,
this is required since CSS variables
does not work well in non-shadow-dom components.

fixes #16099
2018-10-26 18:53:02 +02:00

6202 lines
236 KiB
TypeScript
Raw Blame History

/* 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,
Animation,
AnimationBuilder,
CheckedInputChangeEvent,
Color,
ComponentProps,
ComponentRef,
DatetimeOptions,
DomRenderFn,
FrameworkDelegate,
HeaderFn,
InputChangeEvent,
ItemHeightFn,
ItemRenderFn,
ItemReorderDetail,
LoadingOptions,
MenuChangeEventDetail,
MenuControllerI,
ModalOptions,
Mode,
NavComponent,
NavOptions,
OverlayEventDetail,
OverlaySelect,
PickerButton,
PickerColumn,
PickerOptions,
PopoverOptions,
RangeValue,
RefresherEventDetail,
RouteID,
RouterDirection,
RouterEventDetail,
RouterOutletOptions,
RouteWrite,
ScrollBaseDetail,
ScrollDetail,
SelectInputChangeEvent,
SelectInterface,
SelectPopoverOption,
Side,
SpinnerTypes,
StyleEvent,
TabbarChangedDetail,
TabbarClickDetail,
TabbarLayout,
TabbarPlacement,
TextFieldTypes,
TextInputChangeEvent,
ToastOptions,
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<HTMLIonActionSheetElement>;
/**
* Dismiss the open action sheet overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened action sheet overlay.
*/
'getTop': () => Promise<HTMLIonActionSheetElement | undefined>;
}
interface IonActionSheetControllerAttributes extends StencilHTMLAttributes {}
interface IonActionSheet {
/**
* If `true`, the action sheet will animate. Defaults to `true`.
*/
'animated': boolean;
/**
* If `true`, the action sheet will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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<boolean>;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the action-sheet did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the action-sheet will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the action sheet overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* Subtitle for the action sheet.
*/
'subHeader'?: string;
/**
* If `true`, the action sheet will be translucent. Defaults to `false`.
*/
'translucent': boolean;
}
interface IonActionSheetAttributes extends StencilHTMLAttributes {
/**
* If `true`, the action sheet will animate. Defaults to `true`.
*/
'animated'?: boolean;
/**
* If `true`, the action sheet will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the alert has dismissed.
*/
'onIonActionSheetDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the alert has loaded.
*/
'onIonActionSheetDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the alert has presented.
*/
'onIonActionSheetDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the alert has unloaded.
*/
'onIonActionSheetDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the alert has dismissed.
*/
'onIonActionSheetWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the alert has presented.
*/
'onIonActionSheetWillPresent'?: (event: CustomEvent<void>) => void;
'overlayIndex'?: number;
/**
* Subtitle for the action sheet.
*/
'subHeader'?: string;
/**
* If `true`, the action sheet will be translucent. Defaults to `false`.
*/
'translucent'?: boolean;
}
interface IonAlertController {
/**
* Create an alert overlay with alert options
*/
'create': (opts: AlertOptions) => Promise<HTMLIonAlertElement>;
/**
* Dismiss the open alert overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened alert overlay.
*/
'getTop': () => Promise<HTMLIonAlertElement | undefined>;
}
interface IonAlertControllerAttributes extends StencilHTMLAttributes {}
interface IonAlert {
/**
* If `true`, the alert will animate. Defaults to `true`.
*/
'animated': boolean;
/**
* If `true`, the alert will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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<boolean>;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the alert did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the alert will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the alert overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* The subtitle in the heading of the alert. Displayed under the title.
*/
'subHeader'?: string;
/**
* If `true`, the alert will be translucent. Defaults to `false`.
*/
'translucent': boolean;
}
interface IonAlertAttributes extends StencilHTMLAttributes {
/**
* If `true`, the alert will animate. Defaults to `true`.
*/
'animated'?: boolean;
/**
* If `true`, the alert will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the alert has dismissed.
*/
'onIonAlertDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the alert has presented.
*/
'onIonAlertDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the alert has presented.
*/
'onIonAlertDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the alert has presented.
*/
'onIonAlertDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the alert has dismissed.
*/
'onIonAlertWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the alert has presented.
*/
'onIonAlertWillPresent'?: (event: CustomEvent<void>) => void;
'overlayIndex'?: number;
/**
* The subtitle in the heading of the alert. Displayed under the title.
*/
'subHeader'?: string;
/**
* If `true`, the alert will be translucent. Defaults to `false`.
*/
'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 IonAnimationController {
/**
* Creates an animation instance
*/
'create': (animationBuilder?: AnimationBuilder | undefined, baseEl?: any, opts?: any) => Promise<Animation>;
}
interface IonAnimationControllerAttributes extends StencilHTMLAttributes {}
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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* The text to display in the back button.
*/
'text'?: string | null;
}
interface IonBackdrop {
/**
* If `true`, the backdrop will stop propagation on tap. Defaults to `true`.
*/
'stopPropagation': boolean;
/**
* If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event. Defaults to `true`.
*/
'tappable': boolean;
/**
* If `true`, the backdrop will be visible. Defaults to `true`.
*/
'visible': boolean;
}
interface IonBackdropAttributes extends StencilHTMLAttributes {
/**
* Emitted when the backdrop is tapped.
*/
'onIonBackdropTap'?: (event: CustomEvent<void>) => void;
/**
* If `true`, the backdrop will stop propagation on tap. Defaults to `true`.
*/
'stopPropagation'?: boolean;
/**
* If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event. Defaults to `true`.
*/
'tappable'?: boolean;
/**
* If `true`, the backdrop will be visible. Defaults to `true`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonButton {
/**
* The type of button. Possible values are: `"button"`, `"bar-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. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
*/
'routerDirection'?: RouterDirection;
/**
* The button shape. Possible values are: `"round"`.
*/
'shape'?: 'round';
/**
* The button size. Possible values are: `"small"`, `"default"`, `"large"`.
*/
'size'?: 'small' | 'default' | 'large';
/**
* If `true`, activates a button with a heavier font weight.
*/
'strong': boolean;
/**
* The type of the button. Possible values are: `"submit"`, `"reset"` and `"button"`. Default value is: `"button"`
*/
'type': 'submit' | 'reset' | 'button';
}
interface IonButtonAttributes extends StencilHTMLAttributes {
/**
* The type of button. Possible values are: `"button"`, `"bar-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. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted when the button loses focus.
*/
'onIonBlur'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the button has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* When using a router, it specifies the transition direction when navigating to another page using `href`.
*/
'routerDirection'?: RouterDirection;
/**
* The button shape. Possible values are: `"round"`.
*/
'shape'?: 'round';
/**
* The button size. Possible values are: `"small"`, `"default"`, `"large"`.
*/
'size'?: 'small' | 'default' | 'large';
/**
* If `true`, activates a button with a heavier font weight.
*/
'strong'?: boolean;
/**
* The type of the button. Possible values are: `"submit"`, `"reset"` and `"button"`. Default value is: `"button"`
*/
'type'?: 'submit' | 'reset' | 'button';
}
interface IonButtons {}
interface IonButtonsAttributes extends StencilHTMLAttributes {}
interface IonCardContent {
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
}
interface IonCardContentAttributes extends StencilHTMLAttributes {
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* If `true`, the card header will be translucent. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* If `true`, the card header will be translucent. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonCheckbox {
/**
* If `true`, the checkbox is selected. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'disabled': boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* The name of the control, which is submitted with the form data.
*/
'name': string;
/**
* The value of the checkbox.
*/
'value': string;
}
interface IonCheckboxAttributes extends StencilHTMLAttributes {
/**
* If `true`, the checkbox is selected. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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>) => void;
/**
* Emitted when the checked property has changed.
*/
'onIonChange'?: (event: CustomEvent<CheckedInputChangeEvent>) => void;
/**
* Emitted when the toggle has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => void;
/**
* The value of the checkbox.
*/
'value'?: string;
}
interface IonChipButton {
/**
* 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 chip button. Defaults to `false`.
*/
'disabled': boolean;
/**
* Set to `"clear"` for a transparent button or to `"solid"` for a filled background. Defaults to `"clear"`.
*/
'fill': 'clear' | 'solid';
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
}
interface IonChipButtonAttributes 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 chip button. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* Set to `"clear"` for a transparent button or to `"solid"` for a filled background. Defaults to `"clear"`.
*/
'fill'?: 'clear' | 'solid';
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonChipIcon {
/**
* 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 to `"clear"` for a transparent icon or to `"solid"` for a filled background. Defaults to `"clear"`.
*/
'fill': 'clear' | 'solid';
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* The icon to use. Possible values are the same as `"ion-icon"`.
*/
'name'?: string;
/**
* The icon src to use. Possible values are the same as `"ion-icon"`.
*/
'src'?: string;
}
interface IonChipIconAttributes 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;
/**
* Set to `"clear"` for a transparent icon or to `"solid"` for a filled background. Defaults to `"clear"`.
*/
'fill'?: 'clear' | 'solid';
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* The icon to use. Possible values are the same as `"ion-icon"`.
*/
'name'?: string;
/**
* The icon src to use. Possible values are the same as `"ion-icon"`.
*/
'src'?: 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
}
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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonCol {
/**
* The amount to offset the column, in terms of how many columns it should shift to the right 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 right 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 right 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 right 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 right 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 right of the total available.
*/
'offsetXs'?: string;
/**
* The amount to pull the column, in terms of how many columns it should shift to the left 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 left 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 left 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 left 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 left 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 left of the total available.
*/
'pullXs'?: string;
/**
* The amount to push the column, in terms of how many columns it should shift to the right 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 right 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 right 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 right 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 right 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 right 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 right 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 right 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 right 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 right 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 right 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 right of the total available.
*/
'offsetXs'?: string;
/**
* The amount to pull the column, in terms of how many columns it should shift to the left 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 left 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 left 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 left 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 left 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 left of the total available.
*/
'pullXs'?: string;
/**
* The amount to push the column, in terms of how many columns it should shift to the right 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 right 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 right 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 right 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 right 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 right 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<HTMLElement>;
/**
* Scroll by a specified X/Y distance in the component
*/
'scrollByPoint': (x: number, y: number, duration: number) => Promise<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;
/**
* Scroll to the bottom of the component
*/
'scrollToBottom': (duration?: number) => Promise<void>;
/**
* Scroll to a specified X/Y location in the component
*/
'scrollToPoint': (x: number | null | undefined, y: number | null | undefined, duration?: number) => Promise<void>;
/**
* Scroll to the top of the component
*/
'scrollToTop': (duration?: number) => Promise<void>;
/**
* 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<ScrollDetail>) => void;
/**
* Emitted when the scroll has ended.
*/
'onIonScrollEnd'?: (event: CustomEvent<ScrollBaseDetail>) => void;
/**
* Emitted when the scroll has started.
*/
'onIonScrollStart'?: (event: CustomEvent<ScrollBaseDetail>) => 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. Default: `Cancel`.
*/
'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. Defaults to `false`.
*/
'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. Default: `Done`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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;
/**
* Opens the datetime overlay.
*/
'open': () => Promise<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;
/**
* 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. Default: `Cancel`.
*/
'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. Defaults to `false`.
*/
'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. Default: `Done`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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;
/**
* Emitted when the datetime selection was cancelled.
*/
'onIonCancel'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the value (selected date) has changed.
*/
'onIonChange'?: (event: CustomEvent<InputChangeEvent>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => 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;
/**
* 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. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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;
/**
* If `true`, the fab button will be translucent. Defaults to `false`.
*/
'translucent': boolean;
/**
* The type of the button. Possible values are: `"submit"`, `"reset"` and `"button"`. Default value is: `"button"`
*/
'type': 'submit' | 'reset' | 'button';
}
interface IonFabButtonAttributes extends StencilHTMLAttributes {
/**
* If `true`, the fab button will be show a close icon. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted when the button loses focus.
*/
'onIonBlur'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the button has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => 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;
/**
* If `true`, the fab button will be translucent. Defaults to `false`.
*/
'translucent'?: boolean;
/**
* The type of the button. Possible values are: `"submit"`, `"reset"` and `"button"`. Default value is: `"button"`
*/
'type'?: 'submit' | 'reset' | 'button';
}
interface IonFabList {
/**
* If `true`, the fab list will be show all fab buttons in the list. Defaults to `false`.
*/
'activated': boolean;
/**
* The side the fab list will show on relative to the main fab button. Defaults to `'bottom'`.
*/
'side': 'start' | 'end' | 'top' | 'bottom';
}
interface IonFabListAttributes extends StencilHTMLAttributes {
/**
* If `true`, the fab list will be show all fab buttons in the list. Defaults to `false`.
*/
'activated'?: boolean;
/**
* The side the fab list will show on relative to the main fab button. Defaults to `'bottom'`.
*/
'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. Possible values are: `"center"`, `"start"`, `"end"`.
*/
'horizontal'?: 'start' | 'end' | 'center';
/**
* Where to align the fab vertically in the viewport. Possible values are: `"top"`, `"center"`, `"bottom"`.
*/
'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. Possible values are: `"center"`, `"start"`, `"end"`.
*/
'horizontal'?: 'start' | 'end' | 'center';
/**
* Where to align the fab vertically in the viewport. Possible values are: `"top"`, `"center"`, `"bottom"`.
*/
'vertical'?: 'top' | 'bottom' | 'center';
}
interface IonFooter {
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'translucent': boolean;
}
interface IonFooterAttributes extends StencilHTMLAttributes {
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'translucent'?: boolean;
}
interface IonGrid {
/**
* If `true`, the grid will have a fixed width based on the screen size. Defaults to `false`.
*/
'fixed': boolean;
}
interface IonGridAttributes extends StencilHTMLAttributes {
/**
* If `true`, the grid will have a fixed width based on the screen size. Defaults to `false`.
*/
'fixed'?: boolean;
}
interface IonHeader {
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'translucent': boolean;
}
interface IonHeaderAttributes extends StencilHTMLAttributes {
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'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 <img> 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>) => void;
/**
* The image URL. This attribute is mandatory for the <img> element.
*/
'src'?: string;
}
interface IonInfiniteScrollContent {
/**
* An animated SVG spinner that shows while loading.
*/
'loadingSpinner'?: string;
/**
* Optional text to display while loading.
*/
'loadingText'?: string;
}
interface IonInfiniteScrollContentAttributes extends StencilHTMLAttributes {
/**
* An animated SVG spinner that shows while loading.
*/
'loadingSpinner'?: string;
/**
* 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`. Defaults to `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. Defaults to `15%`.
*/
'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>) => void;
/**
* The position of the infinite scroll element. The value can be either `top` or `bottom`. Defaults to `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. Defaults to `15%`.
*/
'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. Defaults to `"none"`.
*/
'autocapitalize': string;
/**
* Indicates whether the value of the control can be automatically completed by the browser. Defaults to `"off"`.
*/
'autocomplete': string;
/**
* Whether autocorrection should be enabled when the user is entering/editing the text value. Defaults to `"off"`.
*/
'autocorrect': string;
/**
* This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`.
*/
'autofocus': boolean;
/**
* If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`.
*/
'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. Default `0`.
*/
'debounce': number;
/**
* If `true`, the user cannot interact with the input. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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;
/**
* If `true`, the user cannot modify the value. Defaults to `false`.
*/
'readonly': boolean;
/**
* If `true`, the user must fill in a value before submitting a form.
*/
'required': boolean;
/**
* This is a nonstandard attribute supported by Safari that only applies when the type is `"search"`. Its value should be a nonnegative decimal integer.
*/
'results'?: number;
/**
* 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. Defaults to `false`.
*/
'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. Possible values are: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, or `"url"`.
*/
'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. Defaults to `"none"`.
*/
'autocapitalize'?: string;
/**
* Indicates whether the value of the control can be automatically completed by the browser. Defaults to `"off"`.
*/
'autocomplete'?: string;
/**
* Whether autocorrection should be enabled when the user is entering/editing the text value. Defaults to `"off"`.
*/
'autocorrect'?: string;
/**
* This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`.
*/
'autofocus'?: boolean;
/**
* If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`.
*/
'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. Default `0`.
*/
'debounce'?: number;
/**
* If `true`, the user cannot interact with the input. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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>) => void;
/**
* Emitted when the value has changed.
*/
'onIonChange'?: (event: CustomEvent<TextInputChangeEvent>) => void;
/**
* Emitted when the input has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when a keyboard input ocurred.
*/
'onIonInput'?: (event: CustomEvent<KeyboardEvent>) => void;
/**
* Emitted when the input has been created.
*/
'onIonInputDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the input has been removed.
*/
'onIonInputDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => 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;
/**
* If `true`, the user cannot modify the value. Defaults to `false`.
*/
'readonly'?: boolean;
/**
* If `true`, the user must fill in a value before submitting a form.
*/
'required'?: boolean;
/**
* This is a nonstandard attribute supported by Safari that only applies when the type is `"search"`. Its value should be a nonnegative decimal integer.
*/
'results'?: number;
/**
* 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. Defaults to `false`.
*/
'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. Possible values are: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, or `"url"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
}
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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
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. Defaults to `false`.
*/
'disabled': boolean;
/**
* If `true`, the option will expand to take up the available width and cover any other options. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* If `true`, the option will expand to take up the available width and cover any other options. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonItemOptions {
'fireSwipeEvent': () => void;
/**
* The side the option button should be on. Possible values: `"start"` and `"end"`. Defaults to `"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<any>) => void;
/**
* The side the option button should be on. Possible values: `"start"` and `"end"`. Defaults to `"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<void>;
/**
* Close all of the sliding items in the list. Items can also be closed from the [List](../../list/List).
*/
'closeOpened': () => Promise<boolean>;
/**
* If `true`, the user cannot interact with the sliding-item. Defaults to `false`.
*/
'disabled': boolean;
/**
* Get the amount the item is open in pixels.
*/
'getOpenAmount': () => Promise<number>;
/**
* 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<number>;
}
interface IonItemSlidingAttributes extends StencilHTMLAttributes {
/**
* If `true`, the user cannot interact with the sliding-item. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'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`. Defaults to `"ios-arrow-forward"`.
*/
'detailIcon': string;
/**
* If `true`, the user cannot interact with the item. Defaults to `false`.
*/
'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. Available options: `"full"`, `"inset"`, `"none"`.
*/
'lines'?: 'full' | 'inset' | 'none';
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"submit"`, `"reset"` and `"button"`. Default value is: `"button"`
*/
'type': 'submit' | 'reset' | 'button';
}
interface IonItemAttributes extends StencilHTMLAttributes {
/**
* If `true`, a button tag will be rendered and the item will be tappable. Defaults to `false`.
*/
'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`. Defaults to `"ios-arrow-forward"`.
*/
'detailIcon'?: string;
/**
* If `true`, the user cannot interact with the item. Defaults to `false`.
*/
'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. Available options: `"full"`, `"inset"`, `"none"`.
*/
'lines'?: 'full' | 'inset' | 'none';
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"submit"`, `"reset"` and `"button"`. Default value is: `"button"`
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => void;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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<boolean>;
/**
* If `true`, the list will have margin around it and rounded corners. Defaults to `false`.
*/
'inset': boolean;
/**
* How the bottom border should be displayed on all items. Available options: `"full"`, `"inset"`, `"none"`.
*/
'lines'?: 'full' | 'inset' | 'none';
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
}
interface IonListAttributes extends StencilHTMLAttributes {
/**
* If `true`, the list will have margin around it and rounded corners. Defaults to `false`.
*/
'inset'?: boolean;
/**
* How the bottom border should be displayed on all items. Available options: `"full"`, `"inset"`, `"none"`.
*/
'lines'?: 'full' | 'inset' | 'none';
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonLoadingController {
/**
* Create a loading overlay with loading options.
*/
'create': (opts?: LoadingOptions | undefined) => Promise<HTMLIonLoadingElement>;
/**
* Dismiss the open loading overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened loading overlay.
*/
'getTop': () => Promise<HTMLIonLoadingElement | undefined>;
}
interface IonLoadingControllerAttributes extends StencilHTMLAttributes {}
interface IonLoading {
/**
* If `true`, the loading indicator will animate. Defaults to `true`.
*/
'animated': boolean;
/**
* If `true`, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`.
*/
'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<boolean>;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the loading did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the loading will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the loading overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* If `true`, a backdrop will be displayed behind the loading indicator. Defaults to `true`.
*/
'showBackdrop': boolean;
/**
* The name of the spinner to display. Possible values are: `"lines"`, `"lines-small"`, `"dots"`, `"bubbles"`, `"circles"`, `"crescent"`.
*/
'spinner'?: string;
/**
* If `true`, the loading indicator will be translucent. Defaults to `false`.
*/
'translucent': boolean;
}
interface IonLoadingAttributes extends StencilHTMLAttributes {
/**
* If `true`, the loading indicator will animate. Defaults to `true`.
*/
'animated'?: boolean;
/**
* If `true`, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the loading has dismissed.
*/
'onIonLoadingDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the loading has loaded.
*/
'onIonLoadingDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the loading has presented.
*/
'onIonLoadingDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the loading has unloaded.
*/
'onIonLoadingDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the loading has dismissed.
*/
'onIonLoadingWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the loading has presented.
*/
'onIonLoadingWillPresent'?: (event: CustomEvent<void>) => void;
'overlayIndex'?: number;
/**
* If `true`, a backdrop will be displayed behind the loading indicator. Defaults to `true`.
*/
'showBackdrop'?: boolean;
/**
* The name of the spinner to display. Possible values are: `"lines"`, `"lines-small"`, `"dots"`, `"bubbles"`, `"circles"`, `"crescent"`.
*/
'spinner'?: string;
/**
* If `true`, the loading indicator will be translucent. Defaults to `false`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonMenuController {
'_getInstance': () => Promise<MenuControllerI>;
/**
* 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<boolean>;
/**
* 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<HTMLIonMenuElement | undefined>;
/**
* 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<HTMLIonMenuElement | undefined>;
/**
* Returns an array of all menu instances.
*/
'getMenus': () => Promise<HTMLIonMenuElement[]>;
/**
* Returns the instance of the menu already opened, otherwise `null`.
*/
'getOpen': () => Promise<HTMLIonMenuElement | undefined>;
/**
* Returns `true` if any menu is currently animating.
*/
'isAnimating': () => Promise<boolean>;
/**
* Returns `true` if the specified menu is enabled.
*/
'isEnabled': (menuId?: string | null | undefined) => Promise<boolean>;
/**
* 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<boolean>;
/**
* Open the menu.
*/
'open': (menuId?: string | null | undefined) => Promise<boolean>;
/**
* Registers a new animation that can be used in any `ion-menu`. ``` * <ion-menu type="my-animation"> * ```
*/
'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<HTMLIonMenuElement | undefined>;
/**
* Toggle the menu. If it's closed, it will open, and if opened, it will close.
*/
'toggle': (menuId?: string | null | undefined) => Promise<boolean>;
}
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<boolean>;
/**
* The content's id the menu should use.
*/
'contentId'?: string;
/**
* If `true`, the menu is disabled. Defaults to `false`.
*/
'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<boolean>;
/**
* Returns `true` is the menu is open.
*/
'isOpen': () => Promise<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;
/**
* Opens the menu. If the menu is already open or it can't be opened, it returns `false`.
*/
'open': (animated?: boolean) => Promise<boolean>;
/**
* Opens or closes the button. If the operation can't be completed successfully, it returns `false`.
*/
'setOpen': (shouldOpen: boolean, animated?: boolean) => Promise<boolean>;
/**
* Which side of the view the menu should be placed. Default `"start"`.
*/
'side': Side;
/**
* If `true`, swiping the menu is enabled. Defaults to `true`.
*/
'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<boolean>;
/**
* 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. Defaults to `false`.
*/
'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>) => void;
/**
* Emitted when the menu is open.
*/
'onIonDidOpen'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the menu state is changed.
*/
'onIonMenuChange'?: (event: CustomEvent<MenuChangeEventDetail>) => void;
/**
* Emitted when the menu is about to be closed.
*/
'onIonWillClose'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the menu is about to be opened.
*/
'onIonWillOpen'?: (event: CustomEvent<void>) => void;
/**
* Which side of the view the menu should be placed. Default `"start"`.
*/
'side'?: Side;
/**
* If `true`, swiping the menu is enabled. Defaults to `true`.
*/
'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': <T extends ComponentRef>(opts: ModalOptions<T>) => Promise<HTMLIonModalElement>;
/**
* Dismiss the open modal overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened modal overlay.
*/
'getTop': () => Promise<HTMLIonModalElement | undefined>;
}
interface IonModalControllerAttributes extends StencilHTMLAttributes {}
interface IonModal {
/**
* If `true`, the modal will animate. Defaults to `true`.
*/
'animated': boolean;
/**
* If `true`, the modal will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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<boolean>;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the modal did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the modal will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the modal overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* If `true`, a backdrop will be displayed behind the modal. Defaults to `true`.
*/
'showBackdrop': boolean;
}
interface IonModalAttributes extends StencilHTMLAttributes {
/**
* If `true`, the modal will animate. Defaults to `true`.
*/
'animated'?: boolean;
/**
* If `true`, the modal will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the modal has dismissed.
*/
'onIonModalDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the modal has loaded.
*/
'onIonModalDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the modal has presented.
*/
'onIonModalDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the modal has unloaded.
*/
'onIonModalDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the modal has dismissed.
*/
'onIonModalWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the modal has presented.
*/
'onIonModalWillPresent'?: (event: CustomEvent<void>) => void;
'overlayIndex'?: number;
/**
* If `true`, a backdrop will be displayed behind the modal. Defaults to `true`.
*/
'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. Default to `true`.
*/
'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<boolean>;
'delegate'?: FrameworkDelegate;
/**
* Gets the active view
*/
'getActive': () => Promise<ViewController | undefined>;
/**
* Returns the view at the index
*/
'getByIndex': (index: number) => Promise<ViewController | undefined>;
/**
* Gets the previous view
*/
'getPrevious': (view?: ViewController | undefined) => Promise<ViewController | undefined>;
'getRouteId': () => Promise<RouteID | undefined>;
/**
* 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': <T extends NavComponent>(insertIndex: number, component: T, componentProps?: ComponentProps<T> | null | undefined, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<boolean>;
/**
* 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<boolean>;
/**
* 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<boolean>;
/**
* Pop to a specific index in the navigation stack
*/
'popTo': (indexOrViewCtrl: number | ViewController, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<boolean>;
/**
* Navigate back to the root of the stack, no matter how far back that is.
*/
'popToRoot': (opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<boolean>;
/**
* 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': <T extends NavComponent>(component: T, componentProps?: ComponentProps<T> | null | undefined, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<boolean>;
/**
* Removes a page from the nav stack at the specified index.
*/
'removeIndex': (startIndex: number, removeCount?: number, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<boolean>;
/**
* 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<boolean>;
/**
* Set the root for the current navigation stack.
*/
'setRoot': <T extends NavComponent>(component: T, componentProps?: ComponentProps<T> | null | undefined, opts?: NavOptions | null | undefined, done?: TransitionDoneFn | undefined) => Promise<boolean>;
'setRouteId': (id: string, params: { [key: string]: any; } | undefined, direction: number) => Promise<RouteWrite>;
/**
* 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. Default to `true`.
*/
'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;
'delegate'?: FrameworkDelegate;
/**
* Event fired when the nav has changed components
*/
'onIonNavDidChange'?: (event: CustomEvent<void>) => void;
/**
* Event fired when the nav will components
*/
'onIonNavWillChange'?: (event: CustomEvent<void>) => void;
/**
* Event fired when Nav will load a component
*/
'onIonNavWillLoad'?: (event: CustomEvent<void>) => 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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonPickerColumn {
'col': PickerColumn;
}
interface IonPickerColumnAttributes extends StencilHTMLAttributes {
'col'?: PickerColumn;
}
interface IonPickerController {
/**
* Create a picker overlay with picker options.
*/
'create': (opts: PickerOptions) => Promise<HTMLIonPickerElement>;
/**
* Dismiss the open picker overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened picker overlay.
*/
'getTop': () => Promise<HTMLIonPickerElement | undefined>;
}
interface IonPickerControllerAttributes extends StencilHTMLAttributes {}
interface IonPicker {
/**
* If `true`, the picker will animate. Defaults to `true`.
*/
'animated': boolean;
/**
* If `true`, the picker will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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<boolean>;
/**
* 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<PickerColumn | undefined>;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the picker did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the picker will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the picker overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* If `true`, a backdrop will be displayed behind the picker. Defaults to `true`.
*/
'showBackdrop': boolean;
}
interface IonPickerAttributes extends StencilHTMLAttributes {
/**
* If `true`, the picker will animate. Defaults to `true`.
*/
'animated'?: boolean;
/**
* If `true`, the picker will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the picker has dismissed.
*/
'onIonPickerDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the picker has loaded.
*/
'onIonPickerDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the picker has presented.
*/
'onIonPickerDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the picker has unloaded.
*/
'onIonPickerDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the picker has dismissed.
*/
'onIonPickerWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the picker has presented.
*/
'onIonPickerWillPresent'?: (event: CustomEvent<void>) => void;
'overlayIndex'?: number;
/**
* If `true`, a backdrop will be displayed behind the picker. Defaults to `true`.
*/
'showBackdrop'?: boolean;
}
interface IonPopoverController {
/**
* Create a popover overlay with popover options.
*/
'create': <T extends ComponentRef>(opts: PopoverOptions<T>) => Promise<HTMLIonPopoverElement>;
/**
* Dismiss the open popover overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened popover overlay.
*/
'getTop': () => Promise<HTMLIonPopoverElement | undefined>;
}
interface IonPopoverControllerAttributes extends StencilHTMLAttributes {}
interface IonPopover {
/**
* If `true`, the popover will animate. Defaults to `true`.
*/
'animated': boolean;
/**
* If `true`, the popover will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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<boolean>;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the popover did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the popover will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* Present the popover overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* If `true`, a backdrop will be displayed behind the popover. Defaults to `true`.
*/
'showBackdrop': boolean;
/**
* If `true`, the popover will be translucent. Defaults to `false`.
*/
'translucent': boolean;
}
interface IonPopoverAttributes extends StencilHTMLAttributes {
/**
* If `true`, the popover will animate. Defaults to `true`.
*/
'animated'?: boolean;
/**
* If `true`, the popover will be dismissed when the backdrop is clicked. Defaults to `true`.
*/
'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;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the popover has dismissed.
*/
'onIonPopoverDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the popover has loaded.
*/
'onIonPopoverDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the popover has presented.
*/
'onIonPopoverDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the popover has unloaded.
*/
'onIonPopoverDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the popover has dismissed.
*/
'onIonPopoverWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the popover has presented.
*/
'onIonPopoverWillPresent'?: (event: CustomEvent<void>) => void;
'overlayIndex'?: number;
/**
* If `true`, a backdrop will be displayed behind the popover. Defaults to `true`.
*/
'showBackdrop'?: boolean;
/**
* If `true`, the popover will be translucent. Defaults to `false`.
*/
'translucent'?: boolean;
}
interface IonRadioGroup {
/**
* If `true`, the radios can be deselected. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'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<InputChangeEvent>) => void;
/**
* the value of the radio group.
*/
'value'?: any | null;
}
interface IonRadio {
/**
* If `true`, the radio is selected. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'disabled': boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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>) => void;
/**
* Emitted when the radio button has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the radio loads.
*/
'onIonRadioDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the radio unloads.
*/
'onIonRadioDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the radio button is selected.
*/
'onIonSelect'?: (event: CustomEvent<CheckedInputChangeEvent>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => 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. Default `0`.
*/
'debounce': number;
/**
* If `true`, the user cannot interact with the range. Defaults to `false`.
*/
'disabled': boolean;
/**
* Show two knobs. Defaults to `false`.
*/
'dualKnobs': boolean;
/**
* Maximum integer value of the range. Defaults to `100`.
*/
'max': number;
/**
* Minimum integer value of the range. Defaults to `0`.
*/
'min': number;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'pin': boolean;
/**
* If `true`, the knob snaps to tick marks evenly spaced based on the step property value. Defaults to `false`.
*/
'snaps': boolean;
/**
* Specifies the value granularity. Defaults to `1`.
*/
'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. Default `0`.
*/
'debounce'?: number;
/**
* If `true`, the user cannot interact with the range. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* Show two knobs. Defaults to `false`.
*/
'dualKnobs'?: boolean;
/**
* Maximum integer value of the range. Defaults to `100`.
*/
'max'?: number;
/**
* Minimum integer value of the range. Defaults to `0`.
*/
'min'?: number;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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>) => void;
/**
* Emitted when the value property has changed.
*/
'onIonChange'?: (event: CustomEvent<InputChangeEvent>) => void;
/**
* Emitted when the range has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => void;
/**
* If `true`, a pin with integer value is shown when the knob is pressed. Defaults to `false`.
*/
'pin'?: boolean;
/**
* If `true`, the knob snaps to tick marks evenly spaced based on the step property value. Defaults to `false`.
*/
'snaps'?: boolean;
/**
* Specifies the value granularity. Defaults to `1`.
*/
'step'?: number;
/**
* the value of the range.
*/
'value'?: RangeValue;
}
interface IonRefresherContent {
/**
* A static icon to display when you begin to pull down
*/
'pullingIcon'?: string;
/**
* The text you want to display when you begin to pull down
*/
'pullingText'?: string;
/**
* An animated SVG spinner that shows when refreshing begins
*/
'refreshingSpinner'?: string;
/**
* 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;
/**
* The text you want to display when you begin to pull down
*/
'pullingText'?: string;
/**
* An animated SVG spinner that shows when refreshing begins
*/
'refreshingSpinner'?: string;
/**
* 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. Defaults to `280ms`.
*/
'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. Defaults to `false`.
*/
'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<number>;
/**
* 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. Defaults to `60`.
*/
'pullMin': number;
/**
* Time it takes the refresher to to snap back to the `refreshing` state. Defaults to `280ms`.
*/
'snapbackDuration': string;
}
interface IonRefresherAttributes extends StencilHTMLAttributes {
/**
* Time it takes to close the refresher. Defaults to `280ms`.
*/
'closeDuration'?: string;
/**
* If `true`, the refresher will be hidden. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* Emitted while the user is pulling down the content and exposing the refresher.
*/
'onIonPull'?: (event: CustomEvent<void>) => 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<RefresherEventDetail>) => void;
/**
* Emitted when the user begins to start pulling down.
*/
'onIonStart'?: (event: CustomEvent<void>) => 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. Defaults to `60`.
*/
'pullMin'?: number;
/**
* Time it takes the refresher to to snap back to the `refreshing` state. Defaults to `280ms`.
*/
'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<any>;
/**
* If `true`, the reorder will be hidden. Defaults to `true`.
*/
'disabled': boolean;
}
interface IonReorderGroupAttributes extends StencilHTMLAttributes {
/**
* If `true`, the reorder will be hidden. Defaults to `true`.
*/
'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<ItemReorderDetail>) => void;
}
interface IonReorder {}
interface IonReorderAttributes extends StencilHTMLAttributes {}
interface IonRippleEffect {
/**
* Adds the ripple effect to the parent element
*/
'addRipple': (pageX: number, pageY: number) => void;
}
interface IonRippleEffectAttributes extends StencilHTMLAttributes {}
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 perfom 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;
}
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 perfom 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;
}
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<any>) => 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. Default to `true`.
*/
'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<boolean>;
'delegate'?: FrameworkDelegate;
'getRouteId': () => Promise<RouteID | undefined>;
/**
* Set the root component for the given navigation stack
*/
'setRoot': (component: ComponentRef, params?: { [key: string]: any; } | undefined, opts?: RouterOutletOptions | undefined) => Promise<boolean>;
'setRouteId': (id: string, params: { [key: string]: any; } | undefined, direction: number) => Promise<RouteWrite>;
}
interface IonRouterOutletAttributes extends StencilHTMLAttributes {
/**
* If `true`, the router-outlet should animate the transition of components. Default to `true`.
*/
'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;
'delegate'?: FrameworkDelegate;
'onIonNavDidChange'?: (event: CustomEvent<void>) => void;
'onIonNavWillChange'?: (event: CustomEvent<void>) => void;
'onIonNavWillLoad'?: (event: CustomEvent<void>) => void;
}
interface IonRouter {
/**
* Go back to previous page in the window.history.
*/
'goBack': () => Promise<void>;
'navChanged': (intent: number) => Promise<boolean>;
'printDebug': () => void;
/**
* Navigate to the specified URL.
*/
'push': (url: string, direction?: RouterDirection) => Promise<boolean>;
/**
* 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<RouterEventDetail>) => void;
/**
* Event emitted when the route is about to change
*/
'onIonRouteWillChange'?: (event: CustomEvent<RouterEventDetail>) => 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. Defaults to `false`.
*/
'animated': boolean;
/**
* Set the input's autocomplete property. Default `"off"`.
*/
'autocomplete': 'on' | 'off';
/**
* Set the input's autocorrect property. Default `"off"`.
*/
'autocorrect': 'on' | 'off';
/**
* Set the cancel button icon. Only applies to `md` mode. Defaults to `"md-arrow-back"`.
*/
'cancelButtonIcon': string;
/**
* Set the the cancel button text. Only applies to `ios` mode. Default: `"Cancel"`.
*/
'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. Default `250`.
*/
'debounce': number;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Set the input's placeholder. Default `"Search"`.
*/
'placeholder': string;
/**
* The icon to use as the search icon. Defaults to `"search"`.
*/
'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. Defaults to `false`.
*/
'showCancelButton': boolean;
/**
* If `true`, enable spellcheck on the input. Defaults to `false`.
*/
'spellcheck': boolean;
/**
* Set the type of the input. Values: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, `"url"`. Default `"search"`.
*/
'type': string;
/**
* the value of the searchbar.
*/
'value'?: string | null;
}
interface IonSearchbarAttributes extends StencilHTMLAttributes {
/**
* If `true`, enable searchbar animation. Defaults to `false`.
*/
'animated'?: boolean;
/**
* Set the input's autocomplete property. Default `"off"`.
*/
'autocomplete'?: 'on' | 'off';
/**
* Set the input's autocorrect property. Default `"off"`.
*/
'autocorrect'?: 'on' | 'off';
/**
* Set the cancel button icon. Only applies to `md` mode. Defaults to `"md-arrow-back"`.
*/
'cancelButtonIcon'?: string;
/**
* Set the the cancel button text. Only applies to `ios` mode. Default: `"Cancel"`.
*/
'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. Default `250`.
*/
'debounce'?: number;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted when the input loses focus.
*/
'onIonBlur'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the cancel button is clicked.
*/
'onIonCancel'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the value has changed.
*/
'onIonChange'?: (event: CustomEvent<TextInputChangeEvent>) => void;
/**
* Emitted when the clear input button is clicked.
*/
'onIonClear'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the input has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when a keyboard input ocurred.
*/
'onIonInput'?: (event: CustomEvent<KeyboardEvent>) => void;
/**
* Set the input's placeholder. Default `"Search"`.
*/
'placeholder'?: string;
/**
* The icon to use as the search icon. Defaults to `"search"`.
*/
'searchIcon'?: string;
/**
* If `true`, show the cancel button. Defaults to `false`.
*/
'showCancelButton'?: boolean;
/**
* If `true`, enable spellcheck on the input. Defaults to `false`.
*/
'spellcheck'?: boolean;
/**
* Set the type of the input. Values: `"text"`, `"password"`, `"email"`, `"number"`, `"search"`, `"tel"`, `"url"`. Default `"search"`.
*/
'type'?: string;
/**
* the value of the searchbar.
*/
'value'?: string | null;
}
interface IonSegmentButton {
/**
* If `true`, the segment button is selected. Defaults to `false`.
*/
'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 segment button. Defaults to `false`.
*/
'disabled': boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* The value of the segment button.
*/
'value': string;
}
interface IonSegmentButtonAttributes extends StencilHTMLAttributes {
/**
* If `true`, the segment button is selected. Defaults to `false`.
*/
'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 segment button. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted when the segment button is clicked.
*/
'onIonSelect'?: (event: CustomEvent<void>) => 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. Defaults to `false`.
*/
'disabled': boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* 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. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted when the value property has changed.
*/
'onIonChange'?: (event: CustomEvent<TextInputChangeEvent>) => void;
/**
* the value of the segment.
*/
'value'?: string | null;
}
interface IonSelectOption {
/**
* If `true`, the user cannot interact with the select option. Defaults to `false`.
*/
'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. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* Emitted when the select option loads.
*/
'onIonSelectOptionDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the select option unloads.
*/
'onIonSelectOptionDidUnload'?: (event: CustomEvent<void>) => void;
/**
* 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. Default: `Cancel`.
*/
'cancelText': string;
/**
* If `true`, the user cannot interact with the select. Defaults to `false`.
*/
'disabled': boolean;
/**
* The interface the select should use: `action-sheet`, `popover` or `alert`. Default: `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. Possible values are: `"ios"` or `"md"`.
*/
'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. Default: `OK`.
*/
'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<OverlaySelect>;
/**
* 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. Default: `Cancel`.
*/
'cancelText'?: string;
/**
* If `true`, the user cannot interact with the select. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* The interface the select should use: `action-sheet`, `popover` or `alert`. Default: `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. Possible values are: `"ios"` or `"md"`.
*/
'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. Default: `OK`.
*/
'okText'?: string;
/**
* Emitted when the select loses focus.
*/
'onIonBlur'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the selection is cancelled.
*/
'onIonCancel'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the value has changed.
*/
'onIonChange'?: (event: CustomEvent<SelectInputChangeEvent>) => void;
/**
* Emitted when the select has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => 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. Default is 100%
*/
'width': string;
}
interface IonSkeletonTextAttributes extends StencilHTMLAttributes {
/**
* Width for the element to render at. Default is 100%
*/
'width'?: string;
}
interface IonSlide {}
interface IonSlideAttributes extends StencilHTMLAttributes {
'onIonSlideChanged'?: (event: CustomEvent<void>) => void;
}
interface IonSlides {
/**
* Get the index of the active slide.
*/
'getActiveIndex': () => Promise<number>;
/**
* Get the index of the previous slide.
*/
'getPreviousIndex': () => Promise<number>;
/**
* Get whether or not the current slide is the first slide.
*/
'isBeginning': () => Promise<boolean>;
/**
* Get whether or not the current slide is the last slide.
*/
'isEnd': () => Promise<boolean>;
/**
* Get the total number of slides.
*/
'length': () => Promise<number>;
/**
* Lock or unlock the ability to slide to the next slides.
*/
'lockSwipeToNext': (shouldLockSwipeToNext: boolean) => Promise<void>;
/**
* Lock or unlock the ability to slide to the previous slides.
*/
'lockSwipeToPrev': (shouldLockSwipeToPrev: boolean) => Promise<void>;
/**
* Lock or unlock the ability to slide to change slides.
*/
'lockSwipes': (shouldLockSwipes: boolean) => Promise<void>;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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. Defaults to `false`.
*/
'pager': boolean;
/**
* If `true`, show the scrollbar. Defaults to `false`.
*/
'scrollbar': boolean;
/**
* Transition to the next slide.
*/
'slideNext': (speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>;
/**
* Transition to the previous slide.
*/
'slidePrev': (speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>;
/**
* Transition to the specified slide.
*/
'slideTo': (index: number, speed?: number | undefined, runCallbacks?: boolean | undefined) => Promise<void>;
/**
* Start auto play.
*/
'startAutoplay': () => Promise<void>;
/**
* Stop auto play.
*/
'stopAutoplay': () => Promise<void>;
/**
* Update the underlying slider implementation. Call this if you've added or removed child slides.
*/
'update': () => Promise<void>;
}
interface IonSlidesAttributes extends StencilHTMLAttributes {
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the active slide has changed.
*/
'onIonSlideDidChange'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the user double taps on the slide's container.
*/
'onIonSlideDoubleTap'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the slider is actively being moved.
*/
'onIonSlideDrag'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the next slide has ended.
*/
'onIonSlideNextEnd'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the next slide has started.
*/
'onIonSlideNextStart'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the previous slide has ended.
*/
'onIonSlidePrevEnd'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the previous slide has started.
*/
'onIonSlidePrevStart'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the slider is at the last slide.
*/
'onIonSlideReachEnd'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the slider is at its initial position.
*/
'onIonSlideReachStart'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the user taps/clicks on the slide's container.
*/
'onIonSlideTap'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the user releases the touch.
*/
'onIonSlideTouchEnd'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the user first touches the slider.
*/
'onIonSlideTouchStart'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the slide transition has ended.
*/
'onIonSlideTransitionEnd'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the slide transition has started.
*/
'onIonSlideTransitionStart'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the active slide has changed.
*/
'onIonSlideWillChange'?: (event: CustomEvent<void>) => void;
/**
* Emitted after Swiper initialization
*/
'onIonSlidesDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Options to pass to the swiper instance. See http://idangero.us/swiper/api/ for valid options
*/
'options'?: any;
/**
* If `true`, show the pagination. Defaults to `false`.
*/
'pager'?: boolean;
/**
* If `true`, show the scrollbar. Defaults to `false`.
*/
'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. Possible values are: `"lines"`, `"lines-small"`, `"dots"`, `"bubbles"`, `"circles"`, `"crescent"`.
*/
'name'?: SpinnerTypes;
/**
* If `true`, the spinner's animation will be paused. Defaults to `false`.
*/
'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. Possible values are: `"lines"`, `"lines-small"`, `"dots"`, `"bubbles"`, `"circles"`, `"crescent"`.
*/
'name'?: SpinnerTypes;
/**
* If `true`, the spinner's animation will be paused. Defaults to `false`.
*/
'paused'?: boolean;
}
interface IonSplitPane {
/**
* If `true`, the split pane will be hidden. Defaults to `false`.
*/
'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 {
/**
* If `true`, the split pane will be hidden. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* Emitted when the split pane is visible.
*/
'onIonChange'?: (event: CustomEvent<{visible: boolean}>) => void;
/**
* Expression to be called when the split-pane visibility has changed
*/
'onIonSplitPaneVisible'?: (event: CustomEvent) => 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;
/**
* Set the layout of the text and icon in the tabbar.
*/
'layout': TabbarLayout;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Set the position of the tabbar, relative to the content.
*/
'placement': TabbarPlacement;
/**
* The selected tab component
*/
'selectedTab'?: string;
/**
* If `true`, the tab bar will be translucent. Defaults to `false`.
*/
'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;
/**
* Set the layout of the text and icon in the tabbar.
*/
'layout'?: TabbarLayout;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
'onIonTabBarChanged'?: (event: CustomEvent<TabbarChangedDetail>) => void;
/**
* Set the position of the tabbar, relative to the content.
*/
'placement'?: TabbarPlacement;
/**
* The selected tab component
*/
'selectedTab'?: string;
/**
* If `true`, the tab bar will be translucent. Defaults to `false`.
*/
'translucent'?: boolean;
}
interface IonTabButton {
/**
* 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 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 tabbar.
*/
'layout': TabbarLayout;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* 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 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 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 tabbar.
*/
'layout'?: TabbarLayout;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted when the tab bar is clicked
*/
'onIonTabButtonClick'?: (event: CustomEvent<TabbarClickDetail>) => void;
/**
* 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<void>;
/**
* 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 {
'active'?: boolean;
/**
* The component to display inside of the tab.
*/
'component'?: ComponentRef;
'delegate'?: FrameworkDelegate;
/**
* 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<RouteID | undefined>;
/**
* Get the currently selected tab
*/
'getSelected': () => Promise<HTMLIonTabElement | undefined>;
/**
* Get the tab at the given index
*/
'getTab': (tab: string | HTMLIonTabElement) => Promise<HTMLIonTabElement | undefined>;
/**
* A unique name for the tabs.
*/
'name'?: string;
/**
* Index or the Tab instance, of the tab to select.
*/
'select': (tab: string | HTMLIonTabElement) => Promise<boolean>;
'setRouteId': (id: string) => Promise<RouteWrite>;
}
interface IonTabsAttributes extends StencilHTMLAttributes {
/**
* A unique name for the tabs.
*/
'name'?: string;
/**
* Emitted when the tab changes.
*/
'onIonChange'?: (event: CustomEvent<{tab: HTMLIonTabElement}>) => void;
/**
* Emitted when the navigation has finished transitioning to a new component.
*/
'onIonNavDidChange'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the navigation is about to transition to a new component.
*/
'onIonNavWillChange'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the navigation will load a component.
*/
'onIonNavWillLoad'?: (event: CustomEvent<void>) => 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. Possible values are: `"ios"` or `"md"`.
*/
'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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonTextarea {
/**
* Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Defaults to `"none"`.
*/
'autocapitalize': string;
/**
* This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`.
*/
'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. Default `0`.
*/
'debounce': number;
/**
* If `true`, the user cannot interact with the textarea. Defaults to `false`.
*/
'disabled': boolean;
/**
* 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;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* The name of the control, which is submitted with the form data.
*/
'name': string;
/**
* Instructional text that shows before the input has a value.
*/
'placeholder'?: string;
/**
* If `true`, the user cannot modify the value. Defaults to `false`.
*/
'readonly': boolean;
/**
* If `true`, the user must fill in a value before submitting a form.
*/
'required': boolean;
/**
* The number of visible text lines for the control.
*/
'rows'?: number;
/**
* Sets focus on the specified `ion-textarea`. Use this method instead of the global `input.focus()`.
*/
'setFocus': () => void;
/**
* If `true`, the element will have its spelling and grammar checked. Defaults to `false`.
*/
'spellcheck': boolean;
/**
* The value of the textarea.
*/
'value'?: string | null;
/**
* Indicates how the control wraps text. Possible values are: `"hard"`, `"soft"`, `"off"`.
*/
'wrap'?: string;
}
interface IonTextareaAttributes extends StencilHTMLAttributes {
/**
* Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user. Defaults to `"none"`.
*/
'autocapitalize'?: string;
/**
* This Boolean attribute lets you specify that a form control should have input focus when the page loads. Defaults to `false`.
*/
'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. Default `0`.
*/
'debounce'?: number;
/**
* If `true`, the user cannot interact with the textarea. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* 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;
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* The name of the control, which is submitted with the form data.
*/
'name'?: string;
/**
* Emitted when the input loses focus.
*/
'onIonBlur'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the input value has changed.
*/
'onIonChange'?: (event: CustomEvent<TextInputChangeEvent>) => void;
/**
* Emitted when the input has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when a keyboard input ocurred.
*/
'onIonInput'?: (event: CustomEvent<KeyboardEvent>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => void;
/**
* Instructional text that shows before the input has a value.
*/
'placeholder'?: string;
/**
* If `true`, the user cannot modify the value. Defaults to `false`.
*/
'readonly'?: boolean;
/**
* If `true`, the user must fill in a value before submitting a form.
*/
'required'?: boolean;
/**
* The number of visible text lines for the control.
*/
'rows'?: number;
/**
* If `true`, the element will have its spelling and grammar checked. Defaults to `false`.
*/
'spellcheck'?: boolean;
/**
* The value of the textarea.
*/
'value'?: string | null;
/**
* Indicates how the control wraps text. Possible values are: `"hard"`, `"soft"`, `"off"`.
*/
'wrap'?: string;
}
interface IonThumbnail {}
interface IonThumbnailAttributes extends StencilHTMLAttributes {}
interface IonTitle {
/**
* 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;
}
interface IonTitleAttributes 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;
}
interface IonToastController {
/**
* Create a toast overlay with toast options.
*/
'create': (opts?: ToastOptions | undefined) => Promise<HTMLIonToastElement>;
/**
* Dismiss the open toast overlay.
*/
'dismiss': (data?: any, role?: string | undefined, id?: string | undefined) => Promise<boolean>;
/**
* Get the most recently opened toast overlay.
*/
'getTop': () => Promise<HTMLIonToastElement | undefined>;
}
interface IonToastControllerAttributes extends StencilHTMLAttributes {}
interface IonToast {
/**
* If `true`, the toast will animate. Defaults to `true`.
*/
'animated': boolean;
/**
* Text to display in the close button.
*/
'closeButtonText'?: 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;
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
*/
'cssClass'?: string | string[];
/**
* Dismiss the toast overlay after it has been presented.
*/
'dismiss': (data?: any, role?: string | undefined) => Promise<boolean>;
/**
* How many milliseconds to wait before hiding the toast. By default, it will show until `dismiss()` is called.
*/
'duration': number;
/**
* Animation to use when the toast is presented.
*/
'enterAnimation'?: AnimationBuilder;
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
'keyboardClose': boolean;
/**
* Animation to use when the toast is dismissed.
*/
'leaveAnimation'?: AnimationBuilder;
/**
* Message to be shown in the toast.
*/
'message'?: string;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* Returns a promise that resolves when the toast did dismiss.
*/
'onDidDismiss': () => Promise<OverlayEventDetail<any>>;
/**
* Returns a promise that resolves when the toast will dismiss.
*/
'onWillDismiss': () => Promise<OverlayEventDetail<any>>;
'overlayIndex': number;
/**
* The position of the toast on the screen. Possible values: "top", "middle", "bottom".
*/
'position': 'top' | 'bottom' | 'middle';
/**
* Present the toast overlay after it has been created.
*/
'present': () => Promise<void>;
/**
* If `true`, the close button will be displayed. Defaults to `false`.
*/
'showCloseButton': boolean;
/**
* If `true`, the toast will be translucent. Defaults to `false`.
*/
'translucent': boolean;
}
interface IonToastAttributes extends StencilHTMLAttributes {
/**
* If `true`, the toast will animate. Defaults to `true`.
*/
'animated'?: boolean;
/**
* Text to display in the close button.
*/
'closeButtonText'?: 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;
/**
* Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces.
*/
'cssClass'?: string | string[];
/**
* How many milliseconds to wait before hiding the toast. By default, it will show until `dismiss()` is called.
*/
'duration'?: number;
/**
* Animation to use when the toast is presented.
*/
'enterAnimation'?: AnimationBuilder;
/**
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
'keyboardClose'?: boolean;
/**
* Animation to use when the toast is dismissed.
*/
'leaveAnimation'?: AnimationBuilder;
/**
* Message to be shown in the toast.
*/
'message'?: string;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
/**
* Emitted after the toast has dismissed.
*/
'onIonToastDidDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted after the toast has loaded.
*/
'onIonToastDidLoad'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the toast has presented.
*/
'onIonToastDidPresent'?: (event: CustomEvent<void>) => void;
/**
* Emitted after the toast has unloaded.
*/
'onIonToastDidUnload'?: (event: CustomEvent<void>) => void;
/**
* Emitted before the toast has dismissed.
*/
'onIonToastWillDismiss'?: (event: CustomEvent<OverlayEventDetail>) => void;
/**
* Emitted before the toast has presented.
*/
'onIonToastWillPresent'?: (event: CustomEvent<void>) => void;
'overlayIndex'?: number;
/**
* The position of the toast on the screen. Possible values: "top", "middle", "bottom".
*/
'position'?: 'top' | 'bottom' | 'middle';
/**
* If `true`, the close button will be displayed. Defaults to `false`.
*/
'showCloseButton'?: boolean;
/**
* If `true`, the toast will be translucent. Defaults to `false`.
*/
'translucent'?: boolean;
}
interface IonToggle {
/**
* If `true`, the toggle is selected. Defaults to `false`.
*/
'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 toggle. Defaults to `false`.
*/
'disabled': boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
/**
* The name of the control, which is submitted with the form data.
*/
'name': string;
/**
* the value of the toggle.
*/
'value'?: string | null;
}
interface IonToggleAttributes extends StencilHTMLAttributes {
/**
* If `true`, the toggle is selected. Defaults to `false`.
*/
'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 toggle. Defaults to `false`.
*/
'disabled'?: boolean;
/**
* The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`.
*/
'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>) => void;
/**
* Emitted when the value property has changed.
*/
'onIonChange'?: (event: CustomEvent<CheckedInputChangeEvent>) => void;
/**
* Emitted when the toggle has focus.
*/
'onIonFocus'?: (event: CustomEvent<void>) => void;
/**
* Emitted when the styles change.
*/
'onIonStyle'?: (event: CustomEvent<StyleEvent>) => void;
/**
* the value of the toggle.
*/
'value'?: string | null;
}
interface IonToolbar {
/**
* 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. Possible values are: `"ios"` or `"md"`.
*/
'mode': Mode;
}
interface IonToolbarAttributes 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. Possible values are: `"ios"` or `"md"`.
*/
'mode'?: Mode;
}
interface IonVirtualScroll {
/**
* The approximate width of each footer template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This value can use either `px` or `%` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `100%`.
*/
'approxFooterHeight': number;
/**
* The approximate height of each header template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This height value can only use `px` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `40px`.
*/
'approxHeaderHeight': number;
/**
* It is important to provide this if virtual item height will be significantly larger than the default The approximate height of each virtual item template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This height value can only use `px` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `45`.
*/
'approxItemHeight': number;
'domRender'?: DomRenderFn;
/**
* Section footers and the data used within its given template can be dynamically created by passing a function to `footerFn`. The logic within the footer function can decide if the footer template should be used, and what data to give to the footer template. The function must return `null` if a footer cell shouldn't be created.
*/
'footerFn'?: HeaderFn;
/**
* Section headers and the data used within its given template can be dynamically created by passing a function to `headerFn`. For example, a large list of contacts usually has dividers between each letter in the alphabet. App's can provide their own custom `headerFn` which is called with each record within the dataset. The logic within the header function can decide if the header template should be used, and what data to give to the header template. The function must return `null` if a header cell shouldn't be created.
*/
'headerFn'?: HeaderFn;
/**
* An optional function that maps each item within their height. When this function is provides, heavy optimizations and fast path can be taked by `ion-virtual-scroll` leading to massive performance improvements. This function allows to skip all DOM reads, which can be Doing so leads to massive performance
*/
'itemHeight'?: ItemHeightFn;
/**
* The data that builds the templates within the virtual scroll. It's important to note that when this data has changed, then the entire virtual scroll is reset, which is an expensive operation and should be avoided if possible.
*/
'items'?: any[];
/**
* This method marks a subset of items as dirty, so they can be re-rendered. Items should be marked as dirty any time the content or their style changes. The subset of items to be updated can are specifing by an offset and a length.
*/
'markDirty': (offset: number, len?: number) => void;
/**
* This method marks the tail the items array as dirty, so they can be re-rendered. It's equivalent to calling: ``` * virtualScroll.markDirty(lastItemLen, items.length - lastItemLen); * ```
*/
'markDirtyTail': () => void;
/**
* NOTE: only Vanilla JS API.
*/
'nodeRender'?: ItemRenderFn;
/**
* Returns the position of the virtual item at the given index.
*/
'positionForItem': (index: number) => Promise<number>;
/**
* NOTE: only JSX API for stencil. Provide a render function for the footer to be rendered. Returns a JSX virtual-dom.
*/
'renderFooter'?: (item: any, index: number) => any;
/**
* NOTE: only JSX API for stencil. Provide a render function for the header to be rendered. Returns a JSX virtual-dom.
*/
'renderHeader'?: (item: any, index: number) => any;
/**
* NOTE: only JSX API for stencil. Provide a render function for the items to be rendered. Returns a JSX virtual-dom.
*/
'renderItem'?: (item: any, index: number) => any;
}
interface IonVirtualScrollAttributes extends StencilHTMLAttributes {
/**
* The approximate width of each footer template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This value can use either `px` or `%` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `100%`.
*/
'approxFooterHeight'?: number;
/**
* The approximate height of each header template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This height value can only use `px` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `40px`.
*/
'approxHeaderHeight'?: number;
/**
* It is important to provide this if virtual item height will be significantly larger than the default The approximate height of each virtual item template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This height value can only use `px` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `45`.
*/
'approxItemHeight'?: number;
'domRender'?: DomRenderFn;
/**
* Section footers and the data used within its given template can be dynamically created by passing a function to `footerFn`. The logic within the footer function can decide if the footer template should be used, and what data to give to the footer template. The function must return `null` if a footer cell shouldn't be created.
*/
'footerFn'?: HeaderFn;
/**
* Section headers and the data used within its given template can be dynamically created by passing a function to `headerFn`. For example, a large list of contacts usually has dividers between each letter in the alphabet. App's can provide their own custom `headerFn` which is called with each record within the dataset. The logic within the header function can decide if the header template should be used, and what data to give to the header template. The function must return `null` if a header cell shouldn't be created.
*/
'headerFn'?: HeaderFn;
/**
* An optional function that maps each item within their height. When this function is provides, heavy optimizations and fast path can be taked by `ion-virtual-scroll` leading to massive performance improvements. This function allows to skip all DOM reads, which can be Doing so leads to massive performance
*/
'itemHeight'?: ItemHeightFn;
/**
* The data that builds the templates within the virtual scroll. It's important to note that when this data has changed, then the entire virtual scroll is reset, which is an expensive operation and should be avoided if possible.
*/
'items'?: any[];
/**
* NOTE: only Vanilla JS API.
*/
'nodeRender'?: ItemRenderFn;
/**
* NOTE: only JSX API for stencil. Provide a render function for the footer to be rendered. Returns a JSX virtual-dom.
*/
'renderFooter'?: (item: any, index: number) => any;
/**
* NOTE: only JSX API for stencil. Provide a render function for the header to be rendered. Returns a JSX virtual-dom.
*/
'renderHeader'?: (item: any, index: number) => any;
/**
* NOTE: only JSX API for stencil. Provide a render function for the items to be rendered. Returns a JSX virtual-dom.
*/
'renderItem'?: (item: any, index: number) => any;
}
}
declare global {
interface StencilElementInterfaces {
'IonActionSheetController': Components.IonActionSheetController;
'IonActionSheet': Components.IonActionSheet;
'IonAlertController': Components.IonAlertController;
'IonAlert': Components.IonAlert;
'IonAnchor': Components.IonAnchor;
'IonAnimationController': Components.IonAnimationController;
'IonApp': Components.IonApp;
'IonAvatar': Components.IonAvatar;
'IonBackButton': Components.IonBackButton;
'IonBackdrop': Components.IonBackdrop;
'IonBadge': Components.IonBadge;
'IonButton': Components.IonButton;
'IonButtons': Components.IonButtons;
'IonCardContent': Components.IonCardContent;
'IonCardHeader': Components.IonCardHeader;
'IonCardSubtitle': Components.IonCardSubtitle;
'IonCardTitle': Components.IonCardTitle;
'IonCard': Components.IonCard;
'IonCheckbox': Components.IonCheckbox;
'IonChipButton': Components.IonChipButton;
'IonChipIcon': Components.IonChipIcon;
'IonChip': Components.IonChip;
'IonCol': Components.IonCol;
'IonContent': Components.IonContent;
'IonDatetime': Components.IonDatetime;
'IonFabButton': Components.IonFabButton;
'IonFabList': Components.IonFabList;
'IonFab': Components.IonFab;
'IonFooter': Components.IonFooter;
'IonGrid': Components.IonGrid;
'IonHeader': Components.IonHeader;
'IonImg': Components.IonImg;
'IonInfiniteScrollContent': Components.IonInfiniteScrollContent;
'IonInfiniteScroll': Components.IonInfiniteScroll;
'IonInput': Components.IonInput;
'IonItemDivider': Components.IonItemDivider;
'IonItemGroup': Components.IonItemGroup;
'IonItemOption': Components.IonItemOption;
'IonItemOptions': Components.IonItemOptions;
'IonItemSliding': Components.IonItemSliding;
'IonItem': Components.IonItem;
'IonLabel': Components.IonLabel;
'IonListHeader': Components.IonListHeader;
'IonList': Components.IonList;
'IonLoadingController': Components.IonLoadingController;
'IonLoading': Components.IonLoading;
'IonMenuButton': Components.IonMenuButton;
'IonMenuController': Components.IonMenuController;
'IonMenuToggle': Components.IonMenuToggle;
'IonMenu': Components.IonMenu;
'IonModalController': Components.IonModalController;
'IonModal': Components.IonModal;
'IonNavPop': Components.IonNavPop;
'IonNavPush': Components.IonNavPush;
'IonNavSetRoot': Components.IonNavSetRoot;
'IonNav': Components.IonNav;
'IonNote': Components.IonNote;
'IonPickerColumn': Components.IonPickerColumn;
'IonPickerController': Components.IonPickerController;
'IonPicker': Components.IonPicker;
'IonPopoverController': Components.IonPopoverController;
'IonPopover': Components.IonPopover;
'IonRadioGroup': Components.IonRadioGroup;
'IonRadio': Components.IonRadio;
'IonRange': Components.IonRange;
'IonRefresherContent': Components.IonRefresherContent;
'IonRefresher': Components.IonRefresher;
'IonReorderGroup': Components.IonReorderGroup;
'IonReorder': Components.IonReorder;
'IonRippleEffect': Components.IonRippleEffect;
'IonRouteRedirect': Components.IonRouteRedirect;
'IonRoute': Components.IonRoute;
'IonRouterOutlet': Components.IonRouterOutlet;
'IonRouter': Components.IonRouter;
'IonRow': Components.IonRow;
'IonSearchbar': Components.IonSearchbar;
'IonSegmentButton': Components.IonSegmentButton;
'IonSegment': Components.IonSegment;
'IonSelectOption': Components.IonSelectOption;
'IonSelectPopover': Components.IonSelectPopover;
'IonSelect': Components.IonSelect;
'IonSkeletonText': Components.IonSkeletonText;
'IonSlide': Components.IonSlide;
'IonSlides': Components.IonSlides;
'IonSpinner': Components.IonSpinner;
'IonSplitPane': Components.IonSplitPane;
'IonTabBar': Components.IonTabBar;
'IonTabButton': Components.IonTabButton;
'IonTab': Components.IonTab;
'IonTabs': Components.IonTabs;
'IonText': Components.IonText;
'IonTextarea': Components.IonTextarea;
'IonThumbnail': Components.IonThumbnail;
'IonTitle': Components.IonTitle;
'IonToastController': Components.IonToastController;
'IonToast': Components.IonToast;
'IonToggle': Components.IonToggle;
'IonToolbar': Components.IonToolbar;
'IonVirtualScroll': Components.IonVirtualScroll;
}
interface StencilIntrinsicElements {
'ion-action-sheet-controller': Components.IonActionSheetControllerAttributes;
'ion-action-sheet': Components.IonActionSheetAttributes;
'ion-alert-controller': Components.IonAlertControllerAttributes;
'ion-alert': Components.IonAlertAttributes;
'ion-anchor': Components.IonAnchorAttributes;
'ion-animation-controller': Components.IonAnimationControllerAttributes;
'ion-app': Components.IonAppAttributes;
'ion-avatar': Components.IonAvatarAttributes;
'ion-back-button': Components.IonBackButtonAttributes;
'ion-backdrop': Components.IonBackdropAttributes;
'ion-badge': Components.IonBadgeAttributes;
'ion-button': Components.IonButtonAttributes;
'ion-buttons': Components.IonButtonsAttributes;
'ion-card-content': Components.IonCardContentAttributes;
'ion-card-header': Components.IonCardHeaderAttributes;
'ion-card-subtitle': Components.IonCardSubtitleAttributes;
'ion-card-title': Components.IonCardTitleAttributes;
'ion-card': Components.IonCardAttributes;
'ion-checkbox': Components.IonCheckboxAttributes;
'ion-chip-button': Components.IonChipButtonAttributes;
'ion-chip-icon': Components.IonChipIconAttributes;
'ion-chip': Components.IonChipAttributes;
'ion-col': Components.IonColAttributes;
'ion-content': Components.IonContentAttributes;
'ion-datetime': Components.IonDatetimeAttributes;
'ion-fab-button': Components.IonFabButtonAttributes;
'ion-fab-list': Components.IonFabListAttributes;
'ion-fab': Components.IonFabAttributes;
'ion-footer': Components.IonFooterAttributes;
'ion-grid': Components.IonGridAttributes;
'ion-header': Components.IonHeaderAttributes;
'ion-img': Components.IonImgAttributes;
'ion-infinite-scroll-content': Components.IonInfiniteScrollContentAttributes;
'ion-infinite-scroll': Components.IonInfiniteScrollAttributes;
'ion-input': Components.IonInputAttributes;
'ion-item-divider': Components.IonItemDividerAttributes;
'ion-item-group': Components.IonItemGroupAttributes;
'ion-item-option': Components.IonItemOptionAttributes;
'ion-item-options': Components.IonItemOptionsAttributes;
'ion-item-sliding': Components.IonItemSlidingAttributes;
'ion-item': Components.IonItemAttributes;
'ion-label': Components.IonLabelAttributes;
'ion-list-header': Components.IonListHeaderAttributes;
'ion-list': Components.IonListAttributes;
'ion-loading-controller': Components.IonLoadingControllerAttributes;
'ion-loading': Components.IonLoadingAttributes;
'ion-menu-button': Components.IonMenuButtonAttributes;
'ion-menu-controller': Components.IonMenuControllerAttributes;
'ion-menu-toggle': Components.IonMenuToggleAttributes;
'ion-menu': Components.IonMenuAttributes;
'ion-modal-controller': Components.IonModalControllerAttributes;
'ion-modal': Components.IonModalAttributes;
'ion-nav-pop': Components.IonNavPopAttributes;
'ion-nav-push': Components.IonNavPushAttributes;
'ion-nav-set-root': Components.IonNavSetRootAttributes;
'ion-nav': Components.IonNavAttributes;
'ion-note': Components.IonNoteAttributes;
'ion-picker-column': Components.IonPickerColumnAttributes;
'ion-picker-controller': Components.IonPickerControllerAttributes;
'ion-picker': Components.IonPickerAttributes;
'ion-popover-controller': Components.IonPopoverControllerAttributes;
'ion-popover': Components.IonPopoverAttributes;
'ion-radio-group': Components.IonRadioGroupAttributes;
'ion-radio': Components.IonRadioAttributes;
'ion-range': Components.IonRangeAttributes;
'ion-refresher-content': Components.IonRefresherContentAttributes;
'ion-refresher': Components.IonRefresherAttributes;
'ion-reorder-group': Components.IonReorderGroupAttributes;
'ion-reorder': Components.IonReorderAttributes;
'ion-ripple-effect': Components.IonRippleEffectAttributes;
'ion-route-redirect': Components.IonRouteRedirectAttributes;
'ion-route': Components.IonRouteAttributes;
'ion-router-outlet': Components.IonRouterOutletAttributes;
'ion-router': Components.IonRouterAttributes;
'ion-row': Components.IonRowAttributes;
'ion-searchbar': Components.IonSearchbarAttributes;
'ion-segment-button': Components.IonSegmentButtonAttributes;
'ion-segment': Components.IonSegmentAttributes;
'ion-select-option': Components.IonSelectOptionAttributes;
'ion-select-popover': Components.IonSelectPopoverAttributes;
'ion-select': Components.IonSelectAttributes;
'ion-skeleton-text': Components.IonSkeletonTextAttributes;
'ion-slide': Components.IonSlideAttributes;
'ion-slides': Components.IonSlidesAttributes;
'ion-spinner': Components.IonSpinnerAttributes;
'ion-split-pane': Components.IonSplitPaneAttributes;
'ion-tab-bar': Components.IonTabBarAttributes;
'ion-tab-button': Components.IonTabButtonAttributes;
'ion-tab': Components.IonTabAttributes;
'ion-tabs': Components.IonTabsAttributes;
'ion-text': Components.IonTextAttributes;
'ion-textarea': Components.IonTextareaAttributes;
'ion-thumbnail': Components.IonThumbnailAttributes;
'ion-title': Components.IonTitleAttributes;
'ion-toast-controller': Components.IonToastControllerAttributes;
'ion-toast': Components.IonToastAttributes;
'ion-toggle': Components.IonToggleAttributes;
'ion-toolbar': Components.IonToolbarAttributes;
'ion-virtual-scroll': Components.IonVirtualScrollAttributes;
}
interface HTMLIonActionSheetControllerElement extends Components.IonActionSheetController, HTMLStencilElement {}
var HTMLIonActionSheetControllerElement: {
prototype: HTMLIonActionSheetControllerElement;
new (): HTMLIonActionSheetControllerElement;
};
interface HTMLIonActionSheetElement extends Components.IonActionSheet, HTMLStencilElement {}
var HTMLIonActionSheetElement: {
prototype: HTMLIonActionSheetElement;
new (): HTMLIonActionSheetElement;
};
interface HTMLIonAlertControllerElement extends Components.IonAlertController, HTMLStencilElement {}
var HTMLIonAlertControllerElement: {
prototype: HTMLIonAlertControllerElement;
new (): HTMLIonAlertControllerElement;
};
interface HTMLIonAlertElement extends Components.IonAlert, HTMLStencilElement {}
var HTMLIonAlertElement: {
prototype: HTMLIonAlertElement;
new (): HTMLIonAlertElement;
};
interface HTMLIonAnchorElement extends Components.IonAnchor, HTMLStencilElement {}
var HTMLIonAnchorElement: {
prototype: HTMLIonAnchorElement;
new (): HTMLIonAnchorElement;
};
interface HTMLIonAnimationControllerElement extends Components.IonAnimationController, HTMLStencilElement {}
var HTMLIonAnimationControllerElement: {
prototype: HTMLIonAnimationControllerElement;
new (): HTMLIonAnimationControllerElement;
};
interface HTMLIonAppElement extends Components.IonApp, HTMLStencilElement {}
var HTMLIonAppElement: {
prototype: HTMLIonAppElement;
new (): HTMLIonAppElement;
};
interface HTMLIonAvatarElement extends Components.IonAvatar, HTMLStencilElement {}
var HTMLIonAvatarElement: {
prototype: HTMLIonAvatarElement;
new (): HTMLIonAvatarElement;
};
interface HTMLIonBackButtonElement extends Components.IonBackButton, HTMLStencilElement {}
var HTMLIonBackButtonElement: {
prototype: HTMLIonBackButtonElement;
new (): HTMLIonBackButtonElement;
};
interface HTMLIonBackdropElement extends Components.IonBackdrop, HTMLStencilElement {}
var HTMLIonBackdropElement: {
prototype: HTMLIonBackdropElement;
new (): HTMLIonBackdropElement;
};
interface HTMLIonBadgeElement extends Components.IonBadge, HTMLStencilElement {}
var HTMLIonBadgeElement: {
prototype: HTMLIonBadgeElement;
new (): HTMLIonBadgeElement;
};
interface HTMLIonButtonElement extends Components.IonButton, HTMLStencilElement {}
var HTMLIonButtonElement: {
prototype: HTMLIonButtonElement;
new (): HTMLIonButtonElement;
};
interface HTMLIonButtonsElement extends Components.IonButtons, HTMLStencilElement {}
var HTMLIonButtonsElement: {
prototype: HTMLIonButtonsElement;
new (): HTMLIonButtonsElement;
};
interface HTMLIonCardContentElement extends Components.IonCardContent, HTMLStencilElement {}
var HTMLIonCardContentElement: {
prototype: HTMLIonCardContentElement;
new (): HTMLIonCardContentElement;
};
interface HTMLIonCardHeaderElement extends Components.IonCardHeader, HTMLStencilElement {}
var HTMLIonCardHeaderElement: {
prototype: HTMLIonCardHeaderElement;
new (): HTMLIonCardHeaderElement;
};
interface HTMLIonCardSubtitleElement extends Components.IonCardSubtitle, HTMLStencilElement {}
var HTMLIonCardSubtitleElement: {
prototype: HTMLIonCardSubtitleElement;
new (): HTMLIonCardSubtitleElement;
};
interface HTMLIonCardTitleElement extends Components.IonCardTitle, HTMLStencilElement {}
var HTMLIonCardTitleElement: {
prototype: HTMLIonCardTitleElement;
new (): HTMLIonCardTitleElement;
};
interface HTMLIonCardElement extends Components.IonCard, HTMLStencilElement {}
var HTMLIonCardElement: {
prototype: HTMLIonCardElement;
new (): HTMLIonCardElement;
};
interface HTMLIonCheckboxElement extends Components.IonCheckbox, HTMLStencilElement {}
var HTMLIonCheckboxElement: {
prototype: HTMLIonCheckboxElement;
new (): HTMLIonCheckboxElement;
};
interface HTMLIonChipButtonElement extends Components.IonChipButton, HTMLStencilElement {}
var HTMLIonChipButtonElement: {
prototype: HTMLIonChipButtonElement;
new (): HTMLIonChipButtonElement;
};
interface HTMLIonChipIconElement extends Components.IonChipIcon, HTMLStencilElement {}
var HTMLIonChipIconElement: {
prototype: HTMLIonChipIconElement;
new (): HTMLIonChipIconElement;
};
interface HTMLIonChipElement extends Components.IonChip, HTMLStencilElement {}
var HTMLIonChipElement: {
prototype: HTMLIonChipElement;
new (): HTMLIonChipElement;
};
interface HTMLIonColElement extends Components.IonCol, HTMLStencilElement {}
var HTMLIonColElement: {
prototype: HTMLIonColElement;
new (): HTMLIonColElement;
};
interface HTMLIonContentElement extends Components.IonContent, HTMLStencilElement {}
var HTMLIonContentElement: {
prototype: HTMLIonContentElement;
new (): HTMLIonContentElement;
};
interface HTMLIonDatetimeElement extends Components.IonDatetime, HTMLStencilElement {}
var HTMLIonDatetimeElement: {
prototype: HTMLIonDatetimeElement;
new (): HTMLIonDatetimeElement;
};
interface HTMLIonFabButtonElement extends Components.IonFabButton, HTMLStencilElement {}
var HTMLIonFabButtonElement: {
prototype: HTMLIonFabButtonElement;
new (): HTMLIonFabButtonElement;
};
interface HTMLIonFabListElement extends Components.IonFabList, HTMLStencilElement {}
var HTMLIonFabListElement: {
prototype: HTMLIonFabListElement;
new (): HTMLIonFabListElement;
};
interface HTMLIonFabElement extends Components.IonFab, HTMLStencilElement {}
var HTMLIonFabElement: {
prototype: HTMLIonFabElement;
new (): HTMLIonFabElement;
};
interface HTMLIonFooterElement extends Components.IonFooter, HTMLStencilElement {}
var HTMLIonFooterElement: {
prototype: HTMLIonFooterElement;
new (): HTMLIonFooterElement;
};
interface HTMLIonGridElement extends Components.IonGrid, HTMLStencilElement {}
var HTMLIonGridElement: {
prototype: HTMLIonGridElement;
new (): HTMLIonGridElement;
};
interface HTMLIonHeaderElement extends Components.IonHeader, HTMLStencilElement {}
var HTMLIonHeaderElement: {
prototype: HTMLIonHeaderElement;
new (): HTMLIonHeaderElement;
};
interface HTMLIonImgElement extends Components.IonImg, HTMLStencilElement {}
var HTMLIonImgElement: {
prototype: HTMLIonImgElement;
new (): HTMLIonImgElement;
};
interface HTMLIonInfiniteScrollContentElement extends Components.IonInfiniteScrollContent, HTMLStencilElement {}
var HTMLIonInfiniteScrollContentElement: {
prototype: HTMLIonInfiniteScrollContentElement;
new (): HTMLIonInfiniteScrollContentElement;
};
interface HTMLIonInfiniteScrollElement extends Components.IonInfiniteScroll, HTMLStencilElement {}
var HTMLIonInfiniteScrollElement: {
prototype: HTMLIonInfiniteScrollElement;
new (): HTMLIonInfiniteScrollElement;
};
interface HTMLIonInputElement extends Components.IonInput, HTMLStencilElement {}
var HTMLIonInputElement: {
prototype: HTMLIonInputElement;
new (): HTMLIonInputElement;
};
interface HTMLIonItemDividerElement extends Components.IonItemDivider, HTMLStencilElement {}
var HTMLIonItemDividerElement: {
prototype: HTMLIonItemDividerElement;
new (): HTMLIonItemDividerElement;
};
interface HTMLIonItemGroupElement extends Components.IonItemGroup, HTMLStencilElement {}
var HTMLIonItemGroupElement: {
prototype: HTMLIonItemGroupElement;
new (): HTMLIonItemGroupElement;
};
interface HTMLIonItemOptionElement extends Components.IonItemOption, HTMLStencilElement {}
var HTMLIonItemOptionElement: {
prototype: HTMLIonItemOptionElement;
new (): HTMLIonItemOptionElement;
};
interface HTMLIonItemOptionsElement extends Components.IonItemOptions, HTMLStencilElement {}
var HTMLIonItemOptionsElement: {
prototype: HTMLIonItemOptionsElement;
new (): HTMLIonItemOptionsElement;
};
interface HTMLIonItemSlidingElement extends Components.IonItemSliding, HTMLStencilElement {}
var HTMLIonItemSlidingElement: {
prototype: HTMLIonItemSlidingElement;
new (): HTMLIonItemSlidingElement;
};
interface HTMLIonItemElement extends Components.IonItem, HTMLStencilElement {}
var HTMLIonItemElement: {
prototype: HTMLIonItemElement;
new (): HTMLIonItemElement;
};
interface HTMLIonLabelElement extends Components.IonLabel, HTMLStencilElement {}
var HTMLIonLabelElement: {
prototype: HTMLIonLabelElement;
new (): HTMLIonLabelElement;
};
interface HTMLIonListHeaderElement extends Components.IonListHeader, HTMLStencilElement {}
var HTMLIonListHeaderElement: {
prototype: HTMLIonListHeaderElement;
new (): HTMLIonListHeaderElement;
};
interface HTMLIonListElement extends Components.IonList, HTMLStencilElement {}
var HTMLIonListElement: {
prototype: HTMLIonListElement;
new (): HTMLIonListElement;
};
interface HTMLIonLoadingControllerElement extends Components.IonLoadingController, HTMLStencilElement {}
var HTMLIonLoadingControllerElement: {
prototype: HTMLIonLoadingControllerElement;
new (): HTMLIonLoadingControllerElement;
};
interface HTMLIonLoadingElement extends Components.IonLoading, HTMLStencilElement {}
var HTMLIonLoadingElement: {
prototype: HTMLIonLoadingElement;
new (): HTMLIonLoadingElement;
};
interface HTMLIonMenuButtonElement extends Components.IonMenuButton, HTMLStencilElement {}
var HTMLIonMenuButtonElement: {
prototype: HTMLIonMenuButtonElement;
new (): HTMLIonMenuButtonElement;
};
interface HTMLIonMenuControllerElement extends Components.IonMenuController, HTMLStencilElement {}
var HTMLIonMenuControllerElement: {
prototype: HTMLIonMenuControllerElement;
new (): HTMLIonMenuControllerElement;
};
interface HTMLIonMenuToggleElement extends Components.IonMenuToggle, HTMLStencilElement {}
var HTMLIonMenuToggleElement: {
prototype: HTMLIonMenuToggleElement;
new (): HTMLIonMenuToggleElement;
};
interface HTMLIonMenuElement extends Components.IonMenu, HTMLStencilElement {}
var HTMLIonMenuElement: {
prototype: HTMLIonMenuElement;
new (): HTMLIonMenuElement;
};
interface HTMLIonModalControllerElement extends Components.IonModalController, HTMLStencilElement {}
var HTMLIonModalControllerElement: {
prototype: HTMLIonModalControllerElement;
new (): HTMLIonModalControllerElement;
};
interface HTMLIonModalElement extends Components.IonModal, HTMLStencilElement {}
var HTMLIonModalElement: {
prototype: HTMLIonModalElement;
new (): HTMLIonModalElement;
};
interface HTMLIonNavPopElement extends Components.IonNavPop, HTMLStencilElement {}
var HTMLIonNavPopElement: {
prototype: HTMLIonNavPopElement;
new (): HTMLIonNavPopElement;
};
interface HTMLIonNavPushElement extends Components.IonNavPush, HTMLStencilElement {}
var HTMLIonNavPushElement: {
prototype: HTMLIonNavPushElement;
new (): HTMLIonNavPushElement;
};
interface HTMLIonNavSetRootElement extends Components.IonNavSetRoot, HTMLStencilElement {}
var HTMLIonNavSetRootElement: {
prototype: HTMLIonNavSetRootElement;
new (): HTMLIonNavSetRootElement;
};
interface HTMLIonNavElement extends Components.IonNav, HTMLStencilElement {}
var HTMLIonNavElement: {
prototype: HTMLIonNavElement;
new (): HTMLIonNavElement;
};
interface HTMLIonNoteElement extends Components.IonNote, HTMLStencilElement {}
var HTMLIonNoteElement: {
prototype: HTMLIonNoteElement;
new (): HTMLIonNoteElement;
};
interface HTMLIonPickerColumnElement extends Components.IonPickerColumn, HTMLStencilElement {}
var HTMLIonPickerColumnElement: {
prototype: HTMLIonPickerColumnElement;
new (): HTMLIonPickerColumnElement;
};
interface HTMLIonPickerControllerElement extends Components.IonPickerController, HTMLStencilElement {}
var HTMLIonPickerControllerElement: {
prototype: HTMLIonPickerControllerElement;
new (): HTMLIonPickerControllerElement;
};
interface HTMLIonPickerElement extends Components.IonPicker, HTMLStencilElement {}
var HTMLIonPickerElement: {
prototype: HTMLIonPickerElement;
new (): HTMLIonPickerElement;
};
interface HTMLIonPopoverControllerElement extends Components.IonPopoverController, HTMLStencilElement {}
var HTMLIonPopoverControllerElement: {
prototype: HTMLIonPopoverControllerElement;
new (): HTMLIonPopoverControllerElement;
};
interface HTMLIonPopoverElement extends Components.IonPopover, HTMLStencilElement {}
var HTMLIonPopoverElement: {
prototype: HTMLIonPopoverElement;
new (): HTMLIonPopoverElement;
};
interface HTMLIonRadioGroupElement extends Components.IonRadioGroup, HTMLStencilElement {}
var HTMLIonRadioGroupElement: {
prototype: HTMLIonRadioGroupElement;
new (): HTMLIonRadioGroupElement;
};
interface HTMLIonRadioElement extends Components.IonRadio, HTMLStencilElement {}
var HTMLIonRadioElement: {
prototype: HTMLIonRadioElement;
new (): HTMLIonRadioElement;
};
interface HTMLIonRangeElement extends Components.IonRange, HTMLStencilElement {}
var HTMLIonRangeElement: {
prototype: HTMLIonRangeElement;
new (): HTMLIonRangeElement;
};
interface HTMLIonRefresherContentElement extends Components.IonRefresherContent, HTMLStencilElement {}
var HTMLIonRefresherContentElement: {
prototype: HTMLIonRefresherContentElement;
new (): HTMLIonRefresherContentElement;
};
interface HTMLIonRefresherElement extends Components.IonRefresher, HTMLStencilElement {}
var HTMLIonRefresherElement: {
prototype: HTMLIonRefresherElement;
new (): HTMLIonRefresherElement;
};
interface HTMLIonReorderGroupElement extends Components.IonReorderGroup, HTMLStencilElement {}
var HTMLIonReorderGroupElement: {
prototype: HTMLIonReorderGroupElement;
new (): HTMLIonReorderGroupElement;
};
interface HTMLIonReorderElement extends Components.IonReorder, HTMLStencilElement {}
var HTMLIonReorderElement: {
prototype: HTMLIonReorderElement;
new (): HTMLIonReorderElement;
};
interface HTMLIonRippleEffectElement extends Components.IonRippleEffect, HTMLStencilElement {}
var HTMLIonRippleEffectElement: {
prototype: HTMLIonRippleEffectElement;
new (): HTMLIonRippleEffectElement;
};
interface HTMLIonRouteRedirectElement extends Components.IonRouteRedirect, HTMLStencilElement {}
var HTMLIonRouteRedirectElement: {
prototype: HTMLIonRouteRedirectElement;
new (): HTMLIonRouteRedirectElement;
};
interface HTMLIonRouteElement extends Components.IonRoute, HTMLStencilElement {}
var HTMLIonRouteElement: {
prototype: HTMLIonRouteElement;
new (): HTMLIonRouteElement;
};
interface HTMLIonRouterOutletElement extends Components.IonRouterOutlet, HTMLStencilElement {}
var HTMLIonRouterOutletElement: {
prototype: HTMLIonRouterOutletElement;
new (): HTMLIonRouterOutletElement;
};
interface HTMLIonRouterElement extends Components.IonRouter, HTMLStencilElement {}
var HTMLIonRouterElement: {
prototype: HTMLIonRouterElement;
new (): HTMLIonRouterElement;
};
interface HTMLIonRowElement extends Components.IonRow, HTMLStencilElement {}
var HTMLIonRowElement: {
prototype: HTMLIonRowElement;
new (): HTMLIonRowElement;
};
interface HTMLIonSearchbarElement extends Components.IonSearchbar, HTMLStencilElement {}
var HTMLIonSearchbarElement: {
prototype: HTMLIonSearchbarElement;
new (): HTMLIonSearchbarElement;
};
interface HTMLIonSegmentButtonElement extends Components.IonSegmentButton, HTMLStencilElement {}
var HTMLIonSegmentButtonElement: {
prototype: HTMLIonSegmentButtonElement;
new (): HTMLIonSegmentButtonElement;
};
interface HTMLIonSegmentElement extends Components.IonSegment, HTMLStencilElement {}
var HTMLIonSegmentElement: {
prototype: HTMLIonSegmentElement;
new (): HTMLIonSegmentElement;
};
interface HTMLIonSelectOptionElement extends Components.IonSelectOption, HTMLStencilElement {}
var HTMLIonSelectOptionElement: {
prototype: HTMLIonSelectOptionElement;
new (): HTMLIonSelectOptionElement;
};
interface HTMLIonSelectPopoverElement extends Components.IonSelectPopover, HTMLStencilElement {}
var HTMLIonSelectPopoverElement: {
prototype: HTMLIonSelectPopoverElement;
new (): HTMLIonSelectPopoverElement;
};
interface HTMLIonSelectElement extends Components.IonSelect, HTMLStencilElement {}
var HTMLIonSelectElement: {
prototype: HTMLIonSelectElement;
new (): HTMLIonSelectElement;
};
interface HTMLIonSkeletonTextElement extends Components.IonSkeletonText, HTMLStencilElement {}
var HTMLIonSkeletonTextElement: {
prototype: HTMLIonSkeletonTextElement;
new (): HTMLIonSkeletonTextElement;
};
interface HTMLIonSlideElement extends Components.IonSlide, HTMLStencilElement {}
var HTMLIonSlideElement: {
prototype: HTMLIonSlideElement;
new (): HTMLIonSlideElement;
};
interface HTMLIonSlidesElement extends Components.IonSlides, HTMLStencilElement {}
var HTMLIonSlidesElement: {
prototype: HTMLIonSlidesElement;
new (): HTMLIonSlidesElement;
};
interface HTMLIonSpinnerElement extends Components.IonSpinner, HTMLStencilElement {}
var HTMLIonSpinnerElement: {
prototype: HTMLIonSpinnerElement;
new (): HTMLIonSpinnerElement;
};
interface HTMLIonSplitPaneElement extends Components.IonSplitPane, HTMLStencilElement {}
var HTMLIonSplitPaneElement: {
prototype: HTMLIonSplitPaneElement;
new (): HTMLIonSplitPaneElement;
};
interface HTMLIonTabBarElement extends Components.IonTabBar, HTMLStencilElement {}
var HTMLIonTabBarElement: {
prototype: HTMLIonTabBarElement;
new (): HTMLIonTabBarElement;
};
interface HTMLIonTabButtonElement extends Components.IonTabButton, HTMLStencilElement {}
var HTMLIonTabButtonElement: {
prototype: HTMLIonTabButtonElement;
new (): HTMLIonTabButtonElement;
};
interface HTMLIonTabElement extends Components.IonTab, HTMLStencilElement {}
var HTMLIonTabElement: {
prototype: HTMLIonTabElement;
new (): HTMLIonTabElement;
};
interface HTMLIonTabsElement extends Components.IonTabs, HTMLStencilElement {}
var HTMLIonTabsElement: {
prototype: HTMLIonTabsElement;
new (): HTMLIonTabsElement;
};
interface HTMLIonTextElement extends Components.IonText, HTMLStencilElement {}
var HTMLIonTextElement: {
prototype: HTMLIonTextElement;
new (): HTMLIonTextElement;
};
interface HTMLIonTextareaElement extends Components.IonTextarea, HTMLStencilElement {}
var HTMLIonTextareaElement: {
prototype: HTMLIonTextareaElement;
new (): HTMLIonTextareaElement;
};
interface HTMLIonThumbnailElement extends Components.IonThumbnail, HTMLStencilElement {}
var HTMLIonThumbnailElement: {
prototype: HTMLIonThumbnailElement;
new (): HTMLIonThumbnailElement;
};
interface HTMLIonTitleElement extends Components.IonTitle, HTMLStencilElement {}
var HTMLIonTitleElement: {
prototype: HTMLIonTitleElement;
new (): HTMLIonTitleElement;
};
interface HTMLIonToastControllerElement extends Components.IonToastController, HTMLStencilElement {}
var HTMLIonToastControllerElement: {
prototype: HTMLIonToastControllerElement;
new (): HTMLIonToastControllerElement;
};
interface HTMLIonToastElement extends Components.IonToast, HTMLStencilElement {}
var HTMLIonToastElement: {
prototype: HTMLIonToastElement;
new (): HTMLIonToastElement;
};
interface HTMLIonToggleElement extends Components.IonToggle, HTMLStencilElement {}
var HTMLIonToggleElement: {
prototype: HTMLIonToggleElement;
new (): HTMLIonToggleElement;
};
interface HTMLIonToolbarElement extends Components.IonToolbar, HTMLStencilElement {}
var HTMLIonToolbarElement: {
prototype: HTMLIonToolbarElement;
new (): HTMLIonToolbarElement;
};
interface HTMLIonVirtualScrollElement extends Components.IonVirtualScroll, HTMLStencilElement {}
var HTMLIonVirtualScrollElement: {
prototype: HTMLIonVirtualScrollElement;
new (): HTMLIonVirtualScrollElement;
};
interface HTMLElementTagNameMap {
'ion-action-sheet-controller': HTMLIonActionSheetControllerElement
'ion-action-sheet': HTMLIonActionSheetElement
'ion-alert-controller': HTMLIonAlertControllerElement
'ion-alert': HTMLIonAlertElement
'ion-anchor': HTMLIonAnchorElement
'ion-animation-controller': HTMLIonAnimationControllerElement
'ion-app': HTMLIonAppElement
'ion-avatar': HTMLIonAvatarElement
'ion-back-button': HTMLIonBackButtonElement
'ion-backdrop': HTMLIonBackdropElement
'ion-badge': HTMLIonBadgeElement
'ion-button': HTMLIonButtonElement
'ion-buttons': HTMLIonButtonsElement
'ion-card-content': HTMLIonCardContentElement
'ion-card-header': HTMLIonCardHeaderElement
'ion-card-subtitle': HTMLIonCardSubtitleElement
'ion-card-title': HTMLIonCardTitleElement
'ion-card': HTMLIonCardElement
'ion-checkbox': HTMLIonCheckboxElement
'ion-chip-button': HTMLIonChipButtonElement
'ion-chip-icon': HTMLIonChipIconElement
'ion-chip': HTMLIonChipElement
'ion-col': HTMLIonColElement
'ion-content': HTMLIonContentElement
'ion-datetime': HTMLIonDatetimeElement
'ion-fab-button': HTMLIonFabButtonElement
'ion-fab-list': HTMLIonFabListElement
'ion-fab': HTMLIonFabElement
'ion-footer': HTMLIonFooterElement
'ion-grid': HTMLIonGridElement
'ion-header': HTMLIonHeaderElement
'ion-img': HTMLIonImgElement
'ion-infinite-scroll-content': HTMLIonInfiniteScrollContentElement
'ion-infinite-scroll': HTMLIonInfiniteScrollElement
'ion-input': HTMLIonInputElement
'ion-item-divider': HTMLIonItemDividerElement
'ion-item-group': HTMLIonItemGroupElement
'ion-item-option': HTMLIonItemOptionElement
'ion-item-options': HTMLIonItemOptionsElement
'ion-item-sliding': HTMLIonItemSlidingElement
'ion-item': HTMLIonItemElement
'ion-label': HTMLIonLabelElement
'ion-list-header': HTMLIonListHeaderElement
'ion-list': HTMLIonListElement
'ion-loading-controller': HTMLIonLoadingControllerElement
'ion-loading': HTMLIonLoadingElement
'ion-menu-button': HTMLIonMenuButtonElement
'ion-menu-controller': HTMLIonMenuControllerElement
'ion-menu-toggle': HTMLIonMenuToggleElement
'ion-menu': HTMLIonMenuElement
'ion-modal-controller': HTMLIonModalControllerElement
'ion-modal': HTMLIonModalElement
'ion-nav-pop': HTMLIonNavPopElement
'ion-nav-push': HTMLIonNavPushElement
'ion-nav-set-root': HTMLIonNavSetRootElement
'ion-nav': HTMLIonNavElement
'ion-note': HTMLIonNoteElement
'ion-picker-column': HTMLIonPickerColumnElement
'ion-picker-controller': HTMLIonPickerControllerElement
'ion-picker': HTMLIonPickerElement
'ion-popover-controller': HTMLIonPopoverControllerElement
'ion-popover': HTMLIonPopoverElement
'ion-radio-group': HTMLIonRadioGroupElement
'ion-radio': HTMLIonRadioElement
'ion-range': HTMLIonRangeElement
'ion-refresher-content': HTMLIonRefresherContentElement
'ion-refresher': HTMLIonRefresherElement
'ion-reorder-group': HTMLIonReorderGroupElement
'ion-reorder': HTMLIonReorderElement
'ion-ripple-effect': HTMLIonRippleEffectElement
'ion-route-redirect': HTMLIonRouteRedirectElement
'ion-route': HTMLIonRouteElement
'ion-router-outlet': HTMLIonRouterOutletElement
'ion-router': HTMLIonRouterElement
'ion-row': HTMLIonRowElement
'ion-searchbar': HTMLIonSearchbarElement
'ion-segment-button': HTMLIonSegmentButtonElement
'ion-segment': HTMLIonSegmentElement
'ion-select-option': HTMLIonSelectOptionElement
'ion-select-popover': HTMLIonSelectPopoverElement
'ion-select': HTMLIonSelectElement
'ion-skeleton-text': HTMLIonSkeletonTextElement
'ion-slide': HTMLIonSlideElement
'ion-slides': HTMLIonSlidesElement
'ion-spinner': HTMLIonSpinnerElement
'ion-split-pane': HTMLIonSplitPaneElement
'ion-tab-bar': HTMLIonTabBarElement
'ion-tab-button': HTMLIonTabButtonElement
'ion-tab': HTMLIonTabElement
'ion-tabs': HTMLIonTabsElement
'ion-text': HTMLIonTextElement
'ion-textarea': HTMLIonTextareaElement
'ion-thumbnail': HTMLIonThumbnailElement
'ion-title': HTMLIonTitleElement
'ion-toast-controller': HTMLIonToastControllerElement
'ion-toast': HTMLIonToastElement
'ion-toggle': HTMLIonToggleElement
'ion-toolbar': HTMLIonToolbarElement
'ion-virtual-scroll': HTMLIonVirtualScrollElement
}
interface ElementTagNameMap {
'ion-action-sheet-controller': HTMLIonActionSheetControllerElement;
'ion-action-sheet': HTMLIonActionSheetElement;
'ion-alert-controller': HTMLIonAlertControllerElement;
'ion-alert': HTMLIonAlertElement;
'ion-anchor': HTMLIonAnchorElement;
'ion-animation-controller': HTMLIonAnimationControllerElement;
'ion-app': HTMLIonAppElement;
'ion-avatar': HTMLIonAvatarElement;
'ion-back-button': HTMLIonBackButtonElement;
'ion-backdrop': HTMLIonBackdropElement;
'ion-badge': HTMLIonBadgeElement;
'ion-button': HTMLIonButtonElement;
'ion-buttons': HTMLIonButtonsElement;
'ion-card-content': HTMLIonCardContentElement;
'ion-card-header': HTMLIonCardHeaderElement;
'ion-card-subtitle': HTMLIonCardSubtitleElement;
'ion-card-title': HTMLIonCardTitleElement;
'ion-card': HTMLIonCardElement;
'ion-checkbox': HTMLIonCheckboxElement;
'ion-chip-button': HTMLIonChipButtonElement;
'ion-chip-icon': HTMLIonChipIconElement;
'ion-chip': HTMLIonChipElement;
'ion-col': HTMLIonColElement;
'ion-content': HTMLIonContentElement;
'ion-datetime': HTMLIonDatetimeElement;
'ion-fab-button': HTMLIonFabButtonElement;
'ion-fab-list': HTMLIonFabListElement;
'ion-fab': HTMLIonFabElement;
'ion-footer': HTMLIonFooterElement;
'ion-grid': HTMLIonGridElement;
'ion-header': HTMLIonHeaderElement;
'ion-img': HTMLIonImgElement;
'ion-infinite-scroll-content': HTMLIonInfiniteScrollContentElement;
'ion-infinite-scroll': HTMLIonInfiniteScrollElement;
'ion-input': HTMLIonInputElement;
'ion-item-divider': HTMLIonItemDividerElement;
'ion-item-group': HTMLIonItemGroupElement;
'ion-item-option': HTMLIonItemOptionElement;
'ion-item-options': HTMLIonItemOptionsElement;
'ion-item-sliding': HTMLIonItemSlidingElement;
'ion-item': HTMLIonItemElement;
'ion-label': HTMLIonLabelElement;
'ion-list-header': HTMLIonListHeaderElement;
'ion-list': HTMLIonListElement;
'ion-loading-controller': HTMLIonLoadingControllerElement;
'ion-loading': HTMLIonLoadingElement;
'ion-menu-button': HTMLIonMenuButtonElement;
'ion-menu-controller': HTMLIonMenuControllerElement;
'ion-menu-toggle': HTMLIonMenuToggleElement;
'ion-menu': HTMLIonMenuElement;
'ion-modal-controller': HTMLIonModalControllerElement;
'ion-modal': HTMLIonModalElement;
'ion-nav-pop': HTMLIonNavPopElement;
'ion-nav-push': HTMLIonNavPushElement;
'ion-nav-set-root': HTMLIonNavSetRootElement;
'ion-nav': HTMLIonNavElement;
'ion-note': HTMLIonNoteElement;
'ion-picker-column': HTMLIonPickerColumnElement;
'ion-picker-controller': HTMLIonPickerControllerElement;
'ion-picker': HTMLIonPickerElement;
'ion-popover-controller': HTMLIonPopoverControllerElement;
'ion-popover': HTMLIonPopoverElement;
'ion-radio-group': HTMLIonRadioGroupElement;
'ion-radio': HTMLIonRadioElement;
'ion-range': HTMLIonRangeElement;
'ion-refresher-content': HTMLIonRefresherContentElement;
'ion-refresher': HTMLIonRefresherElement;
'ion-reorder-group': HTMLIonReorderGroupElement;
'ion-reorder': HTMLIonReorderElement;
'ion-ripple-effect': HTMLIonRippleEffectElement;
'ion-route-redirect': HTMLIonRouteRedirectElement;
'ion-route': HTMLIonRouteElement;
'ion-router-outlet': HTMLIonRouterOutletElement;
'ion-router': HTMLIonRouterElement;
'ion-row': HTMLIonRowElement;
'ion-searchbar': HTMLIonSearchbarElement;
'ion-segment-button': HTMLIonSegmentButtonElement;
'ion-segment': HTMLIonSegmentElement;
'ion-select-option': HTMLIonSelectOptionElement;
'ion-select-popover': HTMLIonSelectPopoverElement;
'ion-select': HTMLIonSelectElement;
'ion-skeleton-text': HTMLIonSkeletonTextElement;
'ion-slide': HTMLIonSlideElement;
'ion-slides': HTMLIonSlidesElement;
'ion-spinner': HTMLIonSpinnerElement;
'ion-split-pane': HTMLIonSplitPaneElement;
'ion-tab-bar': HTMLIonTabBarElement;
'ion-tab-button': HTMLIonTabButtonElement;
'ion-tab': HTMLIonTabElement;
'ion-tabs': HTMLIonTabsElement;
'ion-text': HTMLIonTextElement;
'ion-textarea': HTMLIonTextareaElement;
'ion-thumbnail': HTMLIonThumbnailElement;
'ion-title': HTMLIonTitleElement;
'ion-toast-controller': HTMLIonToastControllerElement;
'ion-toast': HTMLIonToastElement;
'ion-toggle': HTMLIonToggleElement;
'ion-toolbar': HTMLIonToolbarElement;
'ion-virtual-scroll': HTMLIonVirtualScrollElement;
}
export namespace JSX {
export interface Element {}
export interface IntrinsicElements extends StencilIntrinsicElements {
[tagName: string]: any;
}
}
export interface HTMLAttributes extends StencilHTMLAttributes {}
}
Reference in New Issue View Git Blame Copy Permalink