File: /var/www/vhost/disk-apps/pwa.sports-crowd.com/node_modules/@ionic/core/dist/html.html-data.json
{
"version": 1.1,
"tags": [
{
"name": "ion-accordion",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the accordion cannot be interacted with."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "readonly",
"description": "If `true`, the accordion cannot be interacted with,\nbut does not alter the opacity."
},
{
"name": "toggle-icon",
"description": "The toggle icon to use. This icon will be\nrotated when the accordion is expanded\nor collapsed."
},
{
"name": "toggle-icon-slot",
"description": "The slot inside of `ion-item` to\nplace the toggle icon. Defaults to `'end'`.",
"values": [
{
"name": "end"
},
{
"name": "start"
}
]
},
{
"name": "value",
"description": "The value of the accordion. Defaults to an autogenerated\nvalue."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/accordion/accordion.tsx"
}
]
},
{
"name": "ion-accordion-group",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, all accordions inside of the\naccordion group will animate when expanding\nor collapsing."
},
{
"name": "disabled",
"description": "If `true`, the accordion group cannot be interacted with."
},
{
"name": "expand",
"description": "Describes the expansion behavior for each accordion.\nPossible values are `\"compact\"` and `\"inset\"`.\nDefaults to `\"compact\"`.",
"values": [
{
"name": "compact"
},
{
"name": "inset"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "multiple",
"description": "If `true`, the accordion group can have multiple\naccordion components expanded at the same time."
},
{
"name": "readonly",
"description": "If `true`, the accordion group cannot be interacted with,\nbut does not alter the opacity."
},
{
"name": "value",
"description": "The value of the accordion group."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/accordion-group/accordion-group.tsx"
}
]
},
{
"name": "ion-action-sheet",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the action sheet will animate."
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the action sheet will be dismissed when the backdrop is clicked."
},
{
"name": "css-class",
"description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
},
{
"name": "header",
"description": "Title for the action sheet."
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "sub-header",
"description": "Subtitle for the action sheet."
},
{
"name": "translucent",
"description": "If `true`, the action sheet will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/action-sheet/action-sheet.tsx"
}
]
},
{
"name": "ion-alert",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the alert will animate."
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the alert will be dismissed when the backdrop is clicked."
},
{
"name": "css-class",
"description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
},
{
"name": "header",
"description": "The main title in the heading of the alert."
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
},
{
"name": "message",
"description": "The main message to be displayed in the alert.\n`message` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`<Ionic>`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)\n\nThis property accepts custom HTML as a string.\nDevelopers who only want to pass plain text\ncan disable the custom HTML functionality\nby setting `innerHTMLTemplatesEnabled: false` in the Ionic config."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "sub-header",
"description": "The subtitle in the heading of the alert. Displayed under the title."
},
{
"name": "translucent",
"description": "If `true`, the alert will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/alert/alert.tsx"
}
]
},
{
"name": "ion-app",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/app/app.tsx"
}
]
},
{
"name": "ion-avatar",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/avatar/avatar.tsx"
}
]
},
{
"name": "ion-back-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "default-href",
"description": "The url to navigate back to by default when there is no history."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the button."
},
{
"name": "icon",
"description": "The built-in named SVG icon name or the exact `src` of an SVG file\nto use for the back button."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "text",
"description": "The text to display in the back button."
},
{
"name": "type",
"description": "The type of the button.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/back-button/back-button.tsx"
}
]
},
{
"name": "ion-backdrop",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "stop-propagation",
"description": "If `true`, the backdrop will stop propagation on tap."
},
{
"name": "tappable",
"description": "If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event."
},
{
"name": "visible",
"description": "If `true`, the backdrop will be visible."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/backdrop/backdrop.tsx"
}
]
},
{
"name": "ion-badge",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/badge/badge.tsx"
}
]
},
{
"name": "ion-breadcrumb",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "active",
"description": "If `true`, the breadcrumb will take on a different look to show that\nit is the currently active breadcrumb. Defaults to `true` for the\nlast breadcrumb if it is not set on any."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the breadcrumb."
},
{
"name": "download",
"description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"values": [
{
"name": "back"
},
{
"name": "forward"
},
{
"name": "root"
}
]
},
{
"name": "separator",
"description": "If true, show a separator between this breadcrumb and the next.\nDefaults to `true` for all breadcrumbs except the last."
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/breadcrumb/breadcrumb.tsx"
}
]
},
{
"name": "ion-breadcrumbs",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "items-after-collapse",
"description": "The number of breadcrumbs to show after the collapsed indicator.\nIf `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`,\nthe breadcrumbs will not be collapsed."
},
{
"name": "items-before-collapse",
"description": "The number of breadcrumbs to show before the collapsed indicator.\nIf `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`,\nthe breadcrumbs will not be collapsed."
},
{
"name": "max-items",
"description": "The maximum number of breadcrumbs to show before collapsing."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/breadcrumbs/breadcrumbs.tsx"
}
]
},
{
"name": "ion-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "button-type",
"description": "The type of button."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the button."
},
{
"name": "download",
"description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
},
{
"name": "expand",
"description": "Set to `\"block\"` for a full-width button or to `\"full\"` for a full-width button\nwith square corners and no left or right borders.",
"values": [
{
"name": "block"
},
{
"name": "full"
}
]
},
{
"name": "fill",
"description": "Set to `\"clear\"` for a transparent button that resembles a flat button, to `\"outline\"`\nfor a transparent button with a border, or to `\"solid\"` for a button with a filled background.\nThe default fill is `\"solid\"` except inside of a toolbar, where the default is `\"clear\"`.",
"values": [
{
"name": "clear"
},
{
"name": "default"
},
{
"name": "outline"
},
{
"name": "solid"
}
]
},
{
"name": "form",
"description": "The HTML form element or form element id. Used to submit a form when the button is not a child of the form."
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"values": [
{
"name": "back"
},
{
"name": "forward"
},
{
"name": "root"
}
]
},
{
"name": "shape",
"description": "Set to `\"round\"` for a button with more rounded corners.",
"values": [
{
"name": "round"
}
]
},
{
"name": "size",
"description": "Set to `\"small\"` for a button with less height and padding, to `\"default\"`\nfor a button with the default height and padding, or to `\"large\"` for a button\nwith more height and padding. By default the size is unset, unless the button\nis inside of an item, where the size is `\"small\"` by default. Set the size to\n`\"default\"` inside of an item to make it a standard size button.",
"values": [
{
"name": "default"
},
{
"name": "large"
},
{
"name": "small"
}
]
},
{
"name": "strong",
"description": "If `true`, activates a button with a heavier font weight."
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
},
{
"name": "type",
"description": "The type of the button.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/button/button.tsx"
}
]
},
{
"name": "ion-buttons",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "collapse",
"description": "If true, buttons will disappear when its\nparent toolbar has fully collapsed if the toolbar\nis not the first toolbar. If the toolbar is the\nfirst toolbar, the buttons will be hidden and will\nonly be shown once all toolbars have fully collapsed.\n\nOnly applies in `ios` mode with `collapse` set to\n`true` on `ion-header`.\n\nTypically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)"
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/buttons/buttons.tsx"
}
]
},
{
"name": "ion-card",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "button",
"description": "If `true`, a button tag will be rendered and the card will be tappable."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the card."
},
{
"name": "download",
"description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"values": [
{
"name": "back"
},
{
"name": "forward"
},
{
"name": "root"
}
]
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
},
{
"name": "type",
"description": "The type of the button. Only used when an `onclick` or `button` property is present.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/card/card.tsx"
}
]
},
{
"name": "ion-card-content",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/card-content/card-content.tsx"
}
]
},
{
"name": "ion-card-header",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "translucent",
"description": "If `true`, the card header will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/card-header/card-header.tsx"
}
]
},
{
"name": "ion-card-subtitle",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/card-subtitle/card-subtitle.tsx"
}
]
},
{
"name": "ion-card-title",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/card-title/card-title.tsx"
}
]
},
{
"name": "ion-checkbox",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "checked",
"description": "If `true`, the checkbox is selected."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the checkbox."
},
{
"name": "indeterminate",
"description": "If `true`, the checkbox will visually appear as indeterminate."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "value",
"description": "The value of the checkbox does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a checkbox is analogous to the value of an `<input type=\"checkbox\">`,\nit's only used when the checkbox participates in a native `<form>`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/checkbox/checkbox.tsx"
}
]
},
{
"name": "ion-chip",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the chip."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "outline",
"description": "Display an outline style button."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/chip/chip.tsx"
}
]
},
{
"name": "ion-col",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "offset",
"description": "The amount to offset the column, in terms of how many columns it should shift to the end\nof the total available."
},
{
"name": "offset-lg",
"description": "The amount to offset the column for lg screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "offset-md",
"description": "The amount to offset the column for md screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "offset-sm",
"description": "The amount to offset the column for sm screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "offset-xl",
"description": "The amount to offset the column for xl screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "offset-xs",
"description": "The amount to offset the column for xs screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "pull",
"description": "The amount to pull the column, in terms of how many columns it should shift to the start of\nthe total available."
},
{
"name": "pull-lg",
"description": "The amount to pull the column for lg screens, in terms of how many columns it should shift\nto the start of the total available."
},
{
"name": "pull-md",
"description": "The amount to pull the column for md screens, in terms of how many columns it should shift\nto the start of the total available."
},
{
"name": "pull-sm",
"description": "The amount to pull the column for sm screens, in terms of how many columns it should shift\nto the start of the total available."
},
{
"name": "pull-xl",
"description": "The amount to pull the column for xl screens, in terms of how many columns it should shift\nto the start of the total available."
},
{
"name": "pull-xs",
"description": "The amount to pull the column for xs screens, in terms of how many columns it should shift\nto the start of the total available."
},
{
"name": "push",
"description": "The amount to push the column, in terms of how many columns it should shift to the end\nof the total available."
},
{
"name": "push-lg",
"description": "The amount to push the column for lg screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "push-md",
"description": "The amount to push the column for md screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "push-sm",
"description": "The amount to push the column for sm screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "push-xl",
"description": "The amount to push the column for xl screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "push-xs",
"description": "The amount to push the column for xs screens, in terms of how many columns it should shift\nto the end of the total available."
},
{
"name": "size",
"description": "The size of the column, in terms of how many columns it should take up out of the total\navailable. If `\"auto\"` is passed, the column will be the size of its content."
},
{
"name": "size-lg",
"description": "The size of the column for lg screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
},
{
"name": "size-md",
"description": "The size of the column for md screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
},
{
"name": "size-sm",
"description": "The size of the column for sm screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
},
{
"name": "size-xl",
"description": "The size of the column for xl screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
},
{
"name": "size-xs",
"description": "The size of the column for xs screens, in terms of how many columns it should take up out\nof the total available. If `\"auto\"` is passed, the column will be the size of its content."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/col/col.tsx"
}
]
},
{
"name": "ion-content",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "force-overscroll",
"description": "If `true` and the content does not cause an overflow scroll, the scroll interaction will cause a bounce.\nIf the content exceeds the bounds of ionContent, nothing will change.\nNote, the does not disable the system bounce on iOS. That is an OS level setting."
},
{
"name": "fullscreen",
"description": "If `true`, the content will scroll behind the headers\nand footers. This effect can easily be seen by setting the toolbar\nto transparent."
},
{
"name": "scroll-events",
"description": "Because of performance reasons, ionScroll events are disabled by default, in order to enable them\nand start listening from (ionScroll), set this property to `true`."
},
{
"name": "scroll-x",
"description": "If you want to enable the content scrolling in the X axis, set this property to `true`."
},
{
"name": "scroll-y",
"description": "If you want to disable the content scrolling in the Y axis, set this property to `false`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/content/content.tsx"
}
]
},
{
"name": "ion-datetime",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "cancel-text",
"description": "The text to display on the picker's cancel button."
},
{
"name": "clear-text",
"description": "The text to display on the picker's \"Clear\" button."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "day-values",
"description": "Values used to create the list of selectable days. By default\nevery day is shown for the given month. However, to control exactly which days of\nthe month to display, the `dayValues` input can take a number, an array of numbers, or\na string of comma separated numbers. Note that even if the array days have an invalid\nnumber for the selected month, like `31` in February, it will correctly not show\ndays which are not valid for the selected month."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the datetime."
},
{
"name": "done-text",
"description": "The text to display on the picker's \"Done\" button."
},
{
"name": "first-day-of-week",
"description": "The first day of the week to use for `ion-datetime`. The\ndefault value is `0` and represents Sunday."
},
{
"name": "hour-cycle",
"description": "The hour cycle of the `ion-datetime`. If no value is set, this is\nspecified by the current locale.",
"values": [
{
"name": "h12"
},
{
"name": "h23"
}
]
},
{
"name": "hour-values",
"description": "Values used to create the list of selectable hours. By default\nthe hour values range from `0` to `23` for 24-hour, or `1` to `12` for 12-hour. However,\nto control exactly which hours to display, the `hourValues` input can take a number, an\narray of numbers, or a string of comma separated numbers."
},
{
"name": "locale",
"description": "The locale to use for `ion-datetime`. This\nimpacts month and day name formatting.\nThe `'default'` value refers to the default\nlocale set by your device."
},
{
"name": "max",
"description": "The maximum datetime allowed. Value must be a date string\nfollowing the\n[ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),\n`1996-12-19`. The format does not have to be specific to an exact\ndatetime. For example, the maximum could just be the year, such as `1994`.\nDefaults to the end of this year."
},
{
"name": "min",
"description": "The minimum datetime allowed. Value must be a date string\nfollowing the\n[ISO 8601 datetime format standard](https://www.w3.org/TR/NOTE-datetime),\nsuch as `1996-12-19`. The format does not have to be specific to an exact\ndatetime. For example, the minimum could just be the year, such as `1994`.\nDefaults to the beginning of the year, 100 years ago from today."
},
{
"name": "minute-values",
"description": "Values used to create the list of selectable minutes. By default\nthe minutes range from `0` to `59`. However, to control exactly which minutes to display,\nthe `minuteValues` input can take a number, an array of numbers, or a string of comma\nseparated numbers. For example, if the minute selections should only be every 15 minutes,\nthen this input value would be `minuteValues=\"0,15,30,45\"`."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "month-values",
"description": "Values used to create the list of selectable months. By default\nthe month values range from `1` to `12`. However, to control exactly which months to\ndisplay, the `monthValues` input can take a number, an array of numbers, or a string of\ncomma separated numbers. For example, if only summer months should be shown, then this\ninput value would be `monthValues=\"6,7,8\"`. Note that month numbers do *not* have a\nzero-based index, meaning January's value is `1`, and December's is `12`."
},
{
"name": "multiple",
"description": "If `true`, multiple dates can be selected at once. Only\napplies to `presentation=\"date\"` and `preferWheel=\"false\"`."
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "prefer-wheel",
"description": "If `true`, a wheel picker will be rendered instead of a calendar grid\nwhere possible. If `false`, a calendar grid will be rendered instead of\na wheel picker where possible.\n\nA wheel picker can be rendered instead of a grid when `presentation` is\none of the following values: `'date'`, `'date-time'`, or `'time-date'`.\n\nA wheel picker will always be rendered regardless of\nthe `preferWheel` value when `presentation` is one of the following values:\n`'time'`, `'month'`, `'month-year'`, or `'year'`."
},
{
"name": "presentation",
"description": "Which values you want to select. `'date'` will show\na calendar picker to select the month, day, and year. `'time'`\nwill show a time picker to select the hour, minute, and (optionally)\nAM/PM. `'date-time'` will show the date picker first and time picker second.\n`'time-date'` will show the time picker first and date picker second.",
"values": [
{
"name": "date"
},
{
"name": "date-time"
},
{
"name": "month"
},
{
"name": "month-year"
},
{
"name": "time"
},
{
"name": "time-date"
},
{
"name": "year"
}
]
},
{
"name": "readonly",
"description": "If `true`, the datetime appears normal but is not interactive."
},
{
"name": "show-clear-button",
"description": "If `true`, a \"Clear\" button will be rendered alongside\nthe default \"Cancel\" and \"OK\" buttons at the bottom of the `ion-datetime`\ncomponent. Developers can also use the `button` slot\nif they want to customize these buttons. If custom\nbuttons are set in the `button` slot then the\ndefault buttons will not be rendered."
},
{
"name": "show-default-buttons",
"description": "If `true`, the default \"Cancel\" and \"OK\" buttons\nwill be rendered at the bottom of the `ion-datetime`\ncomponent. Developers can also use the `button` slot\nif they want to customize these buttons. If custom\nbuttons are set in the `button` slot then the\ndefault buttons will not be rendered."
},
{
"name": "show-default-time-label",
"description": "If `true`, the default \"Time\" label will be rendered\nfor the time selector of the `ion-datetime` component.\nDevelopers can also use the `time-label` slot\nif they want to customize this label. If a custom\nlabel is set in the `time-label` slot then the\ndefault label will not be rendered."
},
{
"name": "show-default-title",
"description": "If `true`, a header will be shown above the calendar\npicker. This will include both the slotted title, and\nthe selected date."
},
{
"name": "size",
"description": "If `cover`, the `ion-datetime` will expand to cover the full width of its container.\nIf `fixed`, the `ion-datetime` will have a fixed width.",
"values": [
{
"name": "cover"
},
{
"name": "fixed"
}
]
},
{
"name": "value",
"description": "The value of the datetime as a valid ISO 8601 datetime string.\nShould be an array of strings if `multiple=\"true\"`."
},
{
"name": "year-values",
"description": "Values used to create the list of selectable years. By default\nthe year values range between the `min` and `max` datetime inputs. However, to\ncontrol exactly which years to display, the `yearValues` input can take a number, an array\nof numbers, or string of comma separated numbers. For example, to show upcoming and\nrecent leap years, then this input's value would be `yearValues=\"2024,2020,2016,2012,2008\"`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/datetime/datetime.tsx"
}
]
},
{
"name": "ion-datetime-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "datetime",
"description": "The ID of the `ion-datetime` instance\nassociated with the datetime button."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the button."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/datetime-button/datetime-button.tsx"
}
]
},
{
"name": "ion-fab",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "activated",
"description": "If `true`, both the `ion-fab-button` and all `ion-fab-list` inside `ion-fab` will become active.\nThat means `ion-fab-button` will become a `close` icon and `ion-fab-list` will become visible."
},
{
"name": "edge",
"description": "If `true`, the fab will display on the edge of the header if\n`vertical` is `\"top\"`, and on the edge of the footer if\nit is `\"bottom\"`. Should be used with a `fixed` slot."
},
{
"name": "horizontal",
"description": "Where to align the fab horizontally in the viewport.",
"values": [
{
"name": "center"
},
{
"name": "end"
},
{
"name": "start"
}
]
},
{
"name": "vertical",
"description": "Where to align the fab vertically in the viewport.",
"values": [
{
"name": "bottom"
},
{
"name": "center"
},
{
"name": "top"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/fab/fab.tsx"
}
]
},
{
"name": "ion-fab-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "activated",
"description": "If `true`, the fab button will be show a close icon."
},
{
"name": "close-icon",
"description": "The icon name to use for the close icon. This will appear when the fab button\nis pressed. Only applies if it is the main button inside of a fab containing a\nfab list."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the fab button."
},
{
"name": "download",
"description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"values": [
{
"name": "back"
},
{
"name": "forward"
},
{
"name": "root"
}
]
},
{
"name": "show",
"description": "If `true`, the fab button will show when in a fab-list."
},
{
"name": "size",
"description": "The size of the button. Set this to `small` in order to have a mini fab button.",
"values": [
{
"name": "small"
}
]
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
},
{
"name": "translucent",
"description": "If `true`, the fab button will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
},
{
"name": "type",
"description": "The type of the button.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/fab-button/fab-button.tsx"
}
]
},
{
"name": "ion-fab-list",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "activated",
"description": "If `true`, the fab list will show all fab buttons in the list."
},
{
"name": "side",
"description": "The side the fab list will show on relative to the main fab button.",
"values": [
{
"name": "bottom"
},
{
"name": "end"
},
{
"name": "start"
},
{
"name": "top"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/fab-list/fab-list.tsx"
}
]
},
{
"name": "ion-footer",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "collapse",
"description": "Describes the scroll effect that will be applied to the footer.\nOnly applies in iOS mode.",
"values": [
{
"name": "fade"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "translucent",
"description": "If `true`, the footer will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).\n\nNote: In order to scroll content behind the footer, the `fullscreen`\nattribute needs to be set on the content."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/footer/footer.tsx"
}
]
},
{
"name": "ion-grid",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "fixed",
"description": "If `true`, the grid will have a fixed width based on the screen size."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/grid/grid.tsx"
}
]
},
{
"name": "ion-header",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "collapse",
"description": "Describes the scroll effect that will be applied to the header.\nOnly applies in iOS mode.\n\nTypically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)",
"values": [
{
"name": "condense"
},
{
"name": "fade"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "translucent",
"description": "If `true`, the header will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).\n\nNote: In order to scroll content behind the header, the `fullscreen`\nattribute needs to be set on the content."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/header/header.tsx"
}
]
},
{
"name": "ion-img",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "alt",
"description": "This attribute defines the alternative text describing the image.\nUsers will see this text displayed if the image URL is wrong,\nthe image is not in one of the supported formats, or if the image is not yet downloaded."
},
{
"name": "src",
"description": "The image URL. This attribute is mandatory for the `<img>` element."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/img/img.tsx"
}
]
},
{
"name": "ion-infinite-scroll",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the infinite scroll will be hidden and scroll event listeners\nwill be removed.\n\nSet this to true to disable the infinite scroll from actively\ntrying to receive new data while scrolling. This is useful\nwhen it is known that there is no more data that can be added, and\nthe infinite scroll is no longer needed."
},
{
"name": "position",
"description": "The position of the infinite scroll element.\nThe value can be either `top` or `bottom`.",
"values": [
{
"name": "bottom"
},
{
"name": "top"
}
]
},
{
"name": "threshold",
"description": "The threshold distance from the bottom\nof the content to call the `infinite` output event when scrolled.\nThe threshold value can be either a percent, or\nin pixels. For example, use the value of `10%` for the `infinite`\noutput event to get called when the user has scrolled 10%\nfrom the bottom of the page. Use the value `100px` when the\nscroll is within 100 pixels from the bottom of the page."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/infinite-scroll/infinite-scroll.tsx"
}
]
},
{
"name": "ion-infinite-scroll-content",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "loading-spinner",
"description": "An animated SVG spinner that shows while loading.",
"values": [
{
"name": "bubbles"
},
{
"name": "circles"
},
{
"name": "circular"
},
{
"name": "crescent"
},
{
"name": "dots"
},
{
"name": "lines"
},
{
"name": "lines-sharp"
},
{
"name": "lines-sharp-small"
},
{
"name": "lines-small"
}
]
},
{
"name": "loading-text",
"description": "Optional text to display while loading.\n`loadingText` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`<Ionic>`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)\n\nThis property accepts custom HTML as a string.\nDevelopers who only want to pass plain text\ncan disable the custom HTML functionality\nby setting `innerHTMLTemplatesEnabled: false` in the Ionic config."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/infinite-scroll-content/infinite-scroll-content.tsx"
}
]
},
{
"name": "ion-input",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "accept",
"description": "This attribute is ignored."
},
{
"name": "autocapitalize",
"description": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: `\"off\"`, `\"none\"`, `\"on\"`, `\"sentences\"`, `\"words\"`, `\"characters\"`."
},
{
"name": "autocomplete",
"description": "Indicates whether the value of the control can be automatically completed by the browser.",
"values": [
{
"name": "name"
},
{
"name": "email"
},
{
"name": "tel"
},
{
"name": "url"
},
{
"name": "on"
},
{
"name": "off"
},
{
"name": "honorific-prefix"
},
{
"name": "given-name"
},
{
"name": "additional-name"
},
{
"name": "family-name"
},
{
"name": "honorific-suffix"
},
{
"name": "nickname"
},
{
"name": "username"
},
{
"name": "new-password"
},
{
"name": "current-password"
},
{
"name": "one-time-code"
},
{
"name": "organization-title"
},
{
"name": "organization"
},
{
"name": "street-address"
},
{
"name": "address-line1"
},
{
"name": "address-line2"
},
{
"name": "address-line3"
},
{
"name": "address-level4"
},
{
"name": "address-level3"
},
{
"name": "address-level2"
},
{
"name": "address-level1"
},
{
"name": "country"
},
{
"name": "country-name"
},
{
"name": "postal-code"
},
{
"name": "cc-name"
},
{
"name": "cc-given-name"
},
{
"name": "cc-additional-name"
},
{
"name": "cc-family-name"
},
{
"name": "cc-number"
},
{
"name": "cc-exp"
},
{
"name": "cc-exp-month"
},
{
"name": "cc-exp-year"
},
{
"name": "cc-csc"
},
{
"name": "cc-type"
},
{
"name": "transaction-currency"
},
{
"name": "transaction-amount"
},
{
"name": "language"
},
{
"name": "bday"
},
{
"name": "bday-day"
},
{
"name": "bday-month"
},
{
"name": "bday-year"
},
{
"name": "sex"
},
{
"name": "tel-country-code"
},
{
"name": "tel-national"
},
{
"name": "tel-area-code"
},
{
"name": "tel-local"
},
{
"name": "tel-extension"
},
{
"name": "impp"
},
{
"name": "photo"
}
]
},
{
"name": "autocorrect",
"description": "Whether auto correction should be enabled when the user is entering/editing the text value.",
"values": [
{
"name": "off"
},
{
"name": "on"
}
]
},
{
"name": "autofocus",
"description": "This Boolean attribute lets you specify that a form control should have input focus when the page loads."
},
{
"name": "clear-input",
"description": "If `true`, a clear icon will appear in the input when there is a value. Clicking it clears the input."
},
{
"name": "clear-on-edit",
"description": "If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `\"password\"`, `false` for all other types."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "debounce",
"description": "Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. This also impacts form bindings such as `ngModel` or `v-model`."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the input."
},
{
"name": "enterkeyhint",
"description": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`.",
"values": [
{
"name": "done"
},
{
"name": "enter"
},
{
"name": "go"
},
{
"name": "next"
},
{
"name": "previous"
},
{
"name": "search"
},
{
"name": "send"
}
]
},
{
"name": "inputmode",
"description": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
"values": [
{
"name": "decimal"
},
{
"name": "email"
},
{
"name": "none"
},
{
"name": "numeric"
},
{
"name": "search"
},
{
"name": "tel"
},
{
"name": "text"
},
{
"name": "url"
}
]
},
{
"name": "max",
"description": "The maximum value, which must not be less than its minimum (min attribute) value."
},
{
"name": "maxlength",
"description": "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."
},
{
"name": "min",
"description": "The minimum value, which must not be greater than its maximum (max attribute) value."
},
{
"name": "minlength",
"description": "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."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "multiple",
"description": "If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `\"email\"`, otherwise it is ignored."
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "pattern",
"description": "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\"`, `\"date\"`, or `\"password\"`, otherwise it is ignored. When the type attribute is `\"date\"`, `pattern` will only be used in browsers that do not support the `\"date\"` input type natively. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date for more information."
},
{
"name": "placeholder",
"description": "Instructional text that shows before the input has a value.\nThis property applies only when the `type` property is set to `\"email\"`,\n`\"number\"`, `\"password\"`, `\"search\"`, `\"tel\"`, `\"text\"`, or `\"url\"`, otherwise it is ignored."
},
{
"name": "readonly",
"description": "If `true`, the user cannot modify the value."
},
{
"name": "required",
"description": "If `true`, the user must fill in a value before submitting a form."
},
{
"name": "size",
"description": "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."
},
{
"name": "spellcheck",
"description": "If `true`, the element will have its spelling and grammar checked."
},
{
"name": "step",
"description": "Works with the min and max attributes to limit the increments at which a value can be set.\nPossible values are: `\"any\"` or a positive floating point number."
},
{
"name": "type",
"description": "The type of control to display. The default type is text.",
"values": [
{
"name": "date"
},
{
"name": "datetime-local"
},
{
"name": "email"
},
{
"name": "month"
},
{
"name": "number"
},
{
"name": "password"
},
{
"name": "search"
},
{
"name": "tel"
},
{
"name": "text"
},
{
"name": "time"
},
{
"name": "url"
},
{
"name": "week"
}
]
},
{
"name": "value",
"description": "The value of the input."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/input/input.tsx"
}
]
},
{
"name": "ion-item",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "button",
"description": "If `true`, a button tag will be rendered and the item will be tappable."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "counter",
"description": "If `true`, a character counter will display the ratio of characters used and the total character limit. Only applies when the `maxlength` property is set on the inner `ion-input` or `ion-textarea`."
},
{
"name": "detail",
"description": "If `true`, a detail arrow will appear on the item. Defaults to `false` unless the `mode`\nis `ios` and an `href` or `button` property is present."
},
{
"name": "detail-icon",
"description": "The icon to use when `detail` is set to `true`."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the item."
},
{
"name": "download",
"description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
},
{
"name": "fill",
"description": "The fill for the item. If `'solid'` the item will have a background. If\n`'outline'` the item will be transparent with a border. Only available in `md` mode.",
"values": [
{
"name": "outline"
},
{
"name": "solid"
}
]
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "lines",
"description": "How the bottom border should be displayed on the item.",
"values": [
{
"name": "full"
},
{
"name": "inset"
},
{
"name": "none"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"values": [
{
"name": "back"
},
{
"name": "forward"
},
{
"name": "root"
}
]
},
{
"name": "shape",
"description": "The shape of the item. If \"round\" it will have increased\nborder radius.",
"values": [
{
"name": "round"
}
]
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
},
{
"name": "type",
"description": "The type of the button. Only used when an `onclick` or `button` property is present.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/item/item.tsx"
}
]
},
{
"name": "ion-item-divider",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "sticky",
"description": "When it's set to `true`, the item-divider will stay visible when it reaches the top\nof the viewport until the next `ion-item-divider` replaces it.\n\nThis feature relies in `position:sticky`:\nhttps://caniuse.com/#feat=css-sticky"
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/item-divider/item-divider.tsx"
}
]
},
{
"name": "ion-item-group",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/item-group/item-group.tsx"
}
]
},
{
"name": "ion-item-option",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the item option."
},
{
"name": "download",
"description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
},
{
"name": "expandable",
"description": "If `true`, the option will expand to take up the available width and cover any other options."
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
},
{
"name": "type",
"description": "The type of the button.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/item-option/item-option.tsx"
}
]
},
{
"name": "ion-item-options",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "side",
"description": "The side the option button should be on. Possible values: `\"start\"` and `\"end\"`. If you have multiple `ion-item-options`, a side must be provided for each.",
"values": [
{
"name": "end"
},
{
"name": "start"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/item-options/item-options.tsx"
}
]
},
{
"name": "ion-item-sliding",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the sliding item."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/item-sliding/item-sliding.tsx"
}
]
},
{
"name": "ion-label",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "position",
"description": "The position determines where and how the label behaves inside an item.",
"values": [
{
"name": "fixed"
},
{
"name": "floating"
},
{
"name": "stacked"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/label/label.tsx"
}
]
},
{
"name": "ion-list",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "inset",
"description": "If `true`, the list will have margin around it and rounded corners."
},
{
"name": "lines",
"description": "How the bottom border should be displayed on all items.",
"values": [
{
"name": "full"
},
{
"name": "inset"
},
{
"name": "none"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/list/list.tsx"
}
]
},
{
"name": "ion-list-header",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "lines",
"description": "How the bottom border should be displayed on the list header.",
"values": [
{
"name": "full"
},
{
"name": "inset"
},
{
"name": "none"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/list-header/list-header.tsx"
}
]
},
{
"name": "ion-loading",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the loading indicator will animate."
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the loading indicator will be dismissed when the backdrop is clicked."
},
{
"name": "css-class",
"description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
},
{
"name": "duration",
"description": "Number of milliseconds to wait before dismissing the loading indicator."
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
},
{
"name": "message",
"description": "Optional text content to display in the loading indicator.\n\nThis property accepts custom HTML as a string.\nDevelopers who only want to pass plain text\ncan disable the custom HTML functionality\nby setting `innerHTMLTemplatesEnabled: false` in the Ionic config."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "show-backdrop",
"description": "If `true`, a backdrop will be displayed behind the loading indicator."
},
{
"name": "spinner",
"description": "The name of the spinner to display.",
"values": [
{
"name": "bubbles"
},
{
"name": "circles"
},
{
"name": "circular"
},
{
"name": "crescent"
},
{
"name": "dots"
},
{
"name": "lines"
},
{
"name": "lines-sharp"
},
{
"name": "lines-sharp-small"
},
{
"name": "lines-small"
}
]
},
{
"name": "translucent",
"description": "If `true`, the loading indicator will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/loading/loading.tsx"
}
]
},
{
"name": "ion-menu",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "content-id",
"description": "The `id` of the main content. When using\na router this is typically `ion-router-outlet`.\nWhen not using a router, this is typically\nyour main view's `ion-content`. This is not the\nid of the `ion-content` inside of your `ion-menu`."
},
{
"name": "disabled",
"description": "If `true`, the menu is disabled."
},
{
"name": "max-edge-start",
"description": "The edge threshold for dragging the menu open.\nIf a drag/swipe happens over this value, the menu is not triggered."
},
{
"name": "menu-id",
"description": "An id for the menu."
},
{
"name": "side",
"description": "Which side of the view the menu should be placed.",
"values": [
{
"name": "end"
},
{
"name": "start"
}
]
},
{
"name": "swipe-gesture",
"description": "If `true`, swiping the menu is enabled."
},
{
"name": "type",
"description": "The display type of the menu.\nAvailable options: `\"overlay\"`, `\"reveal\"`, `\"push\"`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/menu/menu.tsx"
}
]
},
{
"name": "ion-menu-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "auto-hide",
"description": "Automatically hides the menu button when the corresponding menu is not active"
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the menu button."
},
{
"name": "menu",
"description": "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"
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "type",
"description": "The type of the button.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/menu-button/menu-button.tsx"
}
]
},
{
"name": "ion-menu-toggle",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "auto-hide",
"description": "Automatically hides the content when the corresponding menu is not active.\n\nBy default, it's `true`. Change it to `false` in order to\nkeep `ion-menu-toggle` always visible regardless the state of the menu."
},
{
"name": "menu",
"description": "Optional property that maps to a Menu's `menuId` prop.\nCan also be `start` or `end` for the menu side.\nThis is used to find the correct menu to toggle.\n\nIf this property is not used, `ion-menu-toggle` will toggle the\nfirst menu that is active."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/menu-toggle/menu-toggle.tsx"
}
]
},
{
"name": "ion-modal",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the modal will animate."
},
{
"name": "backdrop-breakpoint",
"description": "A decimal value between 0 and 1 that indicates the\npoint after which the backdrop will begin to fade in\nwhen using a sheet modal. Prior to this point, the\nbackdrop will be hidden and the content underneath\nthe sheet can be interacted with. This value is exclusive\nmeaning the backdrop will become active after the value\nspecified."
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the modal will be dismissed when the backdrop is clicked."
},
{
"name": "can-dismiss",
"description": "Determines whether or not a modal can dismiss\nwhen calling the `dismiss` method.\n\nIf the value is `true` or the value's function returns `true`, the modal will close when trying to dismiss.\nIf the value is `false` or the value's function returns `false`, the modal will not close when trying to dismiss."
},
{
"name": "handle",
"description": "The horizontal line that displays at the top of a sheet modal. It is `true` by default when\nsetting the `breakpoints` and `initialBreakpoint` properties."
},
{
"name": "handle-behavior",
"description": "The interaction behavior for the sheet modal when the handle is pressed.\n\nDefaults to `\"none\"`, which means the modal will not change size or position when the handle is pressed.\nSet to `\"cycle\"` to let the modal cycle between available breakpoints when pressed.\n\nHandle behavior is unavailable when the `handle` property is set to `false` or\nwhen the `breakpoints` property is not set (using a fullscreen or card modal).",
"values": [
{
"name": "cycle"
},
{
"name": "none"
}
]
},
{
"name": "initial-breakpoint",
"description": "A decimal value between 0 and 1 that indicates the\ninitial point the modal will open at when creating a\nsheet modal. This value must also be listed in the\n`breakpoints` array."
},
{
"name": "is-open",
"description": "If `true`, the modal will open. If `false`, the modal will close.\nUse this if you need finer grained control over presentation, otherwise\njust use the modalController or the `trigger` property.\nNote: `isOpen` will not automatically be set back to `false` when\nthe modal dismisses. You will need to do that in your code."
},
{
"name": "keep-contents-mounted",
"description": "If `true`, the component passed into `ion-modal` will\nautomatically be mounted when the modal is created. The\ncomponent will remain mounted even when the modal is dismissed.\nHowever, the component will be destroyed when the modal is\ndestroyed. This property is not reactive and should only be\nused when initially creating a modal.\n\nNote: This feature only applies to inline modals in JavaScript\nframeworks such as Angular, React, and Vue."
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "show-backdrop",
"description": "If `true`, a backdrop will be displayed behind the modal.\nThis property controls whether or not the backdrop\ndarkens the screen when the modal is presented.\nIt does not control whether or not the backdrop\nis active or present in the DOM."
},
{
"name": "swipe-to-close",
"description": "If `true`, the modal can be swiped to dismiss. Only applies in iOS mode."
},
{
"name": "trigger",
"description": "An ID corresponding to the trigger element that\ncauses the modal to open when clicked."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/modal/modal.tsx"
}
]
},
{
"name": "ion-nav",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the nav should animate the transition of components."
},
{
"name": "root",
"description": "Root NavComponent to load"
},
{
"name": "swipe-gesture",
"description": "If the nav component should allow for swipe-to-go-back."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/nav/nav.tsx"
}
]
},
{
"name": "ion-nav-link",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "component",
"description": "Component to navigate to. Only used if the `routerDirection` is `\"forward\"` or `\"root\"`."
},
{
"name": "router-direction",
"description": "The transition direction when navigating to another page.",
"values": [
{
"name": "back"
},
{
"name": "forward"
},
{
"name": "root"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/nav-link/nav-link.tsx"
}
]
},
{
"name": "ion-note",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/note/note.tsx"
}
]
},
{
"name": "ion-picker",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the picker will animate."
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the picker will be dismissed when the backdrop is clicked."
},
{
"name": "css-class",
"description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
},
{
"name": "duration",
"description": "Number of milliseconds to wait before dismissing the picker."
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "show-backdrop",
"description": "If `true`, a backdrop will be displayed behind the picker."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/picker/picker.tsx"
}
]
},
{
"name": "ion-popover",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "alignment",
"description": "Describes how to align the popover content with the `reference` point.\nDefaults to `'center'` for `ios` mode, and `'start'` for `md` mode.",
"values": [
{
"name": "center"
},
{
"name": "end"
},
{
"name": "start"
}
]
},
{
"name": "animated",
"description": "If `true`, the popover will animate."
},
{
"name": "arrow",
"description": "If `true`, the popover will display an arrow that points at the\n`reference` when running in `ios` mode. Does not apply in `md` mode."
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the popover will be dismissed when the backdrop is clicked."
},
{
"name": "component",
"description": "The component to display inside of the popover.\nYou only need to use this if you are not using\na JavaScript framework. Otherwise, you can just\nslot your component inside of `ion-popover`."
},
{
"name": "dismiss-on-select",
"description": "If `true`, the popover will be automatically\ndismissed when the content has been clicked."
},
{
"name": "event",
"description": "The event to pass to the popover animation."
},
{
"name": "is-open",
"description": "If `true`, the popover will open. If `false`, the popover will close.\nUse this if you need finer grained control over presentation, otherwise\njust use the popoverController or the `trigger` property.\nNote: `isOpen` will not automatically be set back to `false` when\nthe popover dismisses. You will need to do that in your code."
},
{
"name": "keep-contents-mounted",
"description": "If `true`, the component passed into `ion-popover` will\nautomatically be mounted when the popover is created. The\ncomponent will remain mounted even when the popover is dismissed.\nHowever, the component will be destroyed when the popover is\ndestroyed. This property is not reactive and should only be\nused when initially creating a popover.\n\nNote: This feature only applies to inline popovers in JavaScript\nframeworks such as Angular, React, and Vue."
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "reference",
"description": "Describes what to position the popover relative to.\nIf `'trigger'`, the popover will be positioned relative\nto the trigger button. If passing in an event, this is\ndetermined via event.target.\nIf `'event'`, the popover will be positioned relative\nto the x/y coordinates of the trigger action. If passing\nin an event, this is determined via event.clientX and event.clientY.",
"values": [
{
"name": "event"
},
{
"name": "trigger"
}
]
},
{
"name": "show-backdrop",
"description": "If `true`, a backdrop will be displayed behind the popover.\nThis property controls whether or not the backdrop\ndarkens the screen when the popover is presented.\nIt does not control whether or not the backdrop\nis active or present in the DOM."
},
{
"name": "side",
"description": "Describes which side of the `reference` point to position\nthe popover on. The `'start'` and `'end'` values are RTL-aware,\nand the `'left'` and `'right'` values are not.",
"values": [
{
"name": "bottom"
},
{
"name": "end"
},
{
"name": "left"
},
{
"name": "right"
},
{
"name": "start"
},
{
"name": "top"
}
]
},
{
"name": "size",
"description": "Describes how to calculate the popover width.\nIf `'cover'`, the popover width will match the width of the trigger.\nIf `'auto'`, the popover width will be determined by the content in\nthe popover.",
"values": [
{
"name": "auto"
},
{
"name": "cover"
}
]
},
{
"name": "translucent",
"description": "If `true`, the popover will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
},
{
"name": "trigger",
"description": "An ID corresponding to the trigger element that\ncauses the popover to open. Use the `trigger-action`\nproperty to customize the interaction that results in\nthe popover opening."
},
{
"name": "trigger-action",
"description": "Describes what kind of interaction with the trigger that\nshould cause the popover to open. Does not apply when the `trigger`\nproperty is `undefined`.\nIf `'click'`, the popover will be presented when the trigger is left clicked.\nIf `'hover'`, the popover will be presented when a pointer hovers over the trigger.\nIf `'context-menu'`, the popover will be presented when the trigger is right\nclicked on desktop and long pressed on mobile. This will also prevent your\ndevice's normal context menu from appearing.",
"values": [
{
"name": "click"
},
{
"name": "context-menu"
},
{
"name": "hover"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/popover/popover.tsx"
}
]
},
{
"name": "ion-progress-bar",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "buffer",
"description": "If the buffer and value are smaller than 1, the buffer circles will show.\nThe buffer should be between [0, 1]."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "reversed",
"description": "If true, reverse the progress bar direction."
},
{
"name": "type",
"description": "The state of the progress bar, based on if the time the process takes is known or not.\nDefault options are: `\"determinate\"` (no animation), `\"indeterminate\"` (animate from left to right).",
"values": [
{
"name": "determinate"
},
{
"name": "indeterminate"
}
]
},
{
"name": "value",
"description": "The value determines how much of the active bar should display when the\n`type` is `\"determinate\"`.\nThe value should be between [0, 1]."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/progress-bar/progress-bar.tsx"
}
]
},
{
"name": "ion-radio",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the radio."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "value",
"description": "the value of the radio."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/radio/radio.tsx"
}
]
},
{
"name": "ion-radio-group",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "allow-empty-selection",
"description": "If `true`, the radios can be deselected."
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "value",
"description": "the value of the radio group."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/radio-group/radio-group.tsx"
}
]
},
{
"name": "ion-range",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "active-bar-start",
"description": "The start position of the range active bar. This feature is only available with a single knob (dualKnobs=\"false\").\nValid values are greater than or equal to the min value and less than or equal to the max value."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "debounce",
"description": "How long, in milliseconds, to wait to trigger the\n`ionChange` event after each change in the range value.\nThis also impacts form bindings such as `ngModel` or `v-model`."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the range."
},
{
"name": "dual-knobs",
"description": "Show two knobs."
},
{
"name": "max",
"description": "Maximum integer value of the range."
},
{
"name": "min",
"description": "Minimum integer value of the range."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "pin",
"description": "If `true`, a pin with integer value is shown when the knob\nis pressed."
},
{
"name": "snaps",
"description": "If `true`, the knob snaps to tick marks evenly spaced based\non the step property value."
},
{
"name": "step",
"description": "Specifies the value granularity."
},
{
"name": "ticks",
"description": "If `true`, tick marks are displayed based on the step value.\nOnly applies when `snaps` is `true`."
},
{
"name": "value",
"description": "the value of the range."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/range/range.tsx"
}
]
},
{
"name": "ion-refresher",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "close-duration",
"description": "Time it takes to close the refresher.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
},
{
"name": "disabled",
"description": "If `true`, the refresher will be hidden."
},
{
"name": "pull-factor",
"description": "How much to multiply the pull speed by. To slow the pull animation down,\npass a number less than `1`. To speed up the pull, pass a number greater\nthan `1`. The default value is `1` which is equal to the speed of the cursor.\nIf a negative value is passed in, the factor will be `1` instead.\n\nFor example: If the value passed is `1.2` and the content is dragged by\n`10` pixels, instead of `10` pixels the content will be pulled by `12` pixels\n(an increase of 20 percent). If the value passed is `0.8`, the dragged amount\nwill be `8` pixels, less than the amount the cursor has moved.\n\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
},
{
"name": "pull-max",
"description": "The maximum distance of the pull until the refresher\nwill automatically go into the `refreshing` state.\nDefaults to the result of `pullMin + 60`.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
},
{
"name": "pull-min",
"description": "The minimum distance the user must pull down until the\nrefresher will go into the `refreshing` state.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
},
{
"name": "snapback-duration",
"description": "Time it takes the refresher to snap back to the `refreshing` state.\nDoes not apply when the refresher content uses a spinner,\nenabling the native refresher."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/refresher/refresher.tsx"
}
]
},
{
"name": "ion-refresher-content",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "pulling-icon",
"description": "A static icon or a spinner to display when you begin to pull down.\nA spinner name can be provided to gradually show tick marks\nwhen pulling down on iOS devices."
},
{
"name": "pulling-text",
"description": "The text you want to display when you begin to pull down.\n`pullingText` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`<Ionic>`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)\n\nThis property accepts custom HTML as a string.\nDevelopers who only want to pass plain text\ncan disable the custom HTML functionality\nby setting `innerHTMLTemplatesEnabled: false` in the Ionic config."
},
{
"name": "refreshing-spinner",
"description": "An animated SVG spinner that shows when refreshing begins",
"values": [
{
"name": "bubbles"
},
{
"name": "circles"
},
{
"name": "circular"
},
{
"name": "crescent"
},
{
"name": "dots"
},
{
"name": "lines"
},
{
"name": "lines-sharp"
},
{
"name": "lines-sharp-small"
},
{
"name": "lines-small"
}
]
},
{
"name": "refreshing-text",
"description": "The text you want to display when performing a refresh.\n`refreshingText` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`<Ionic>`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)\n\nThis property accepts custom HTML as a string.\nDevelopers who only want to pass plain text\ncan disable the custom HTML functionality\nby setting `innerHTMLTemplatesEnabled: false` in the Ionic config."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/refresher-content/refresher-content.tsx"
}
]
},
{
"name": "ion-reorder",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/reorder/reorder.tsx"
}
]
},
{
"name": "ion-reorder-group",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the reorder will be hidden."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/reorder-group/reorder-group.tsx"
}
]
},
{
"name": "ion-ripple-effect",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "type",
"description": "Sets the type of ripple-effect:\n\n- `bounded`: the ripple effect expands from the user's click position\n- `unbounded`: the ripple effect expands from the center of the button and overflows the container.\n\nNOTE: Surfaces for bounded ripples should have the overflow property set to hidden,\nwhile surfaces for unbounded ripples should have it set to visible.",
"values": [
{
"name": "bounded"
},
{
"name": "unbounded"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/ripple-effect/ripple-effect.tsx"
}
]
},
{
"name": "ion-route",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "component",
"description": "Name of the component to load/select in the navigation outlet (`ion-tabs`, `ion-nav`)\nwhen the route matches.\n\nThe value of this property is not always the tagname of the component to load,\nin `ion-tabs` it actually refers to the name of the `ion-tab` to select."
},
{
"name": "url",
"description": "Relative path that needs to match in order for this route to apply.\n\nAccepts paths similar to expressjs so that you can define parameters\nin the url /foo/:bar where bar would be available in incoming props."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/route/route.tsx"
}
]
},
{
"name": "ion-route-redirect",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "from",
"description": "A redirect route, redirects \"from\" a URL \"to\" another URL. This property is that \"from\" URL.\nIt needs to be an exact match of the navigated URL in order to apply.\n\nThe path specified in this value is always an absolute path, even if the initial `/` slash\nis not specified."
},
{
"name": "to",
"description": "A redirect route, redirects \"from\" a URL \"to\" another URL. This property is that \"to\" URL.\nWhen the defined `ion-route-redirect` rule matches, the router will redirect to the path\nspecified in this property.\n\nThe value of this property is always an absolute path inside the scope of routes defined in\n`ion-router` it can't be used with another router or to perform a redirection to a different domain.\n\nNote that this is a virtual redirect, it will not cause a real browser refresh, again, it's\na redirect inside the context of ion-router.\n\nWhen this property is not specified or his value is `undefined` the whole redirect route is noop,\neven if the \"from\" value matches."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/route-redirect/route-redirect.tsx"
}
]
},
{
"name": "ion-router",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "root",
"description": "The root path to use when matching URLs. By default, this is set to \"/\", but you can specify\nan alternate prefix for all URL paths."
},
{
"name": "use-hash",
"description": "The router can work in two \"modes\":\n- With hash: `/index.html#/path/to/page`\n- Without hash: `/path/to/page`\n\nUsing one or another might depend in the requirements of your app and/or where it's deployed.\n\nUsually \"hash-less\" navigation works better for SEO and it's more user friendly too, but it might\nrequires additional server-side configuration in order to properly work.\n\nOn the other side hash-navigation is much easier to deploy, it even works over the file protocol.\n\nBy default, this property is `true`, change to `false` to allow hash-less URLs."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/router/router.tsx"
}
]
},
{
"name": "ion-router-link",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"values": [
{
"name": "back"
},
{
"name": "forward"
},
{
"name": "root"
}
]
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/router-link/router-link.tsx"
}
]
},
{
"name": "ion-router-outlet",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the router-outlet should animate the transition of components."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/router-outlet/route-outlet.tsx"
}
]
},
{
"name": "ion-row",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/row/row.tsx"
}
]
},
{
"name": "ion-searchbar",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, enable searchbar animation."
},
{
"name": "autocomplete",
"description": "Set the input's autocomplete property.",
"values": [
{
"name": "name"
},
{
"name": "email"
},
{
"name": "tel"
},
{
"name": "url"
},
{
"name": "on"
},
{
"name": "off"
},
{
"name": "honorific-prefix"
},
{
"name": "given-name"
},
{
"name": "additional-name"
},
{
"name": "family-name"
},
{
"name": "honorific-suffix"
},
{
"name": "nickname"
},
{
"name": "username"
},
{
"name": "new-password"
},
{
"name": "current-password"
},
{
"name": "one-time-code"
},
{
"name": "organization-title"
},
{
"name": "organization"
},
{
"name": "street-address"
},
{
"name": "address-line1"
},
{
"name": "address-line2"
},
{
"name": "address-line3"
},
{
"name": "address-level4"
},
{
"name": "address-level3"
},
{
"name": "address-level2"
},
{
"name": "address-level1"
},
{
"name": "country"
},
{
"name": "country-name"
},
{
"name": "postal-code"
},
{
"name": "cc-name"
},
{
"name": "cc-given-name"
},
{
"name": "cc-additional-name"
},
{
"name": "cc-family-name"
},
{
"name": "cc-number"
},
{
"name": "cc-exp"
},
{
"name": "cc-exp-month"
},
{
"name": "cc-exp-year"
},
{
"name": "cc-csc"
},
{
"name": "cc-type"
},
{
"name": "transaction-currency"
},
{
"name": "transaction-amount"
},
{
"name": "language"
},
{
"name": "bday"
},
{
"name": "bday-day"
},
{
"name": "bday-month"
},
{
"name": "bday-year"
},
{
"name": "sex"
},
{
"name": "tel-country-code"
},
{
"name": "tel-national"
},
{
"name": "tel-area-code"
},
{
"name": "tel-local"
},
{
"name": "tel-extension"
},
{
"name": "impp"
},
{
"name": "photo"
}
]
},
{
"name": "autocorrect",
"description": "Set the input's autocorrect property.",
"values": [
{
"name": "off"
},
{
"name": "on"
}
]
},
{
"name": "cancel-button-icon",
"description": "Set the cancel button icon. Only applies to `md` mode.\nDefaults to `arrow-back-sharp`."
},
{
"name": "cancel-button-text",
"description": "Set the the cancel button text. Only applies to `ios` mode."
},
{
"name": "clear-icon",
"description": "Set the clear icon. Defaults to `close-circle` for `ios` and `close-sharp` for `md`."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "debounce",
"description": "Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. This also impacts form bindings such as `ngModel` or `v-model`."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the input."
},
{
"name": "enterkeyhint",
"description": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`.",
"values": [
{
"name": "done"
},
{
"name": "enter"
},
{
"name": "go"
},
{
"name": "next"
},
{
"name": "previous"
},
{
"name": "search"
},
{
"name": "send"
}
]
},
{
"name": "inputmode",
"description": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
"values": [
{
"name": "decimal"
},
{
"name": "email"
},
{
"name": "none"
},
{
"name": "numeric"
},
{
"name": "search"
},
{
"name": "tel"
},
{
"name": "text"
},
{
"name": "url"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "placeholder",
"description": "Set the input's placeholder.\n`placeholder` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`<Ionic>`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)"
},
{
"name": "search-icon",
"description": "The icon to use as the search icon. Defaults to `search-outline` in\n`ios` mode and `search-sharp` in `md` mode."
},
{
"name": "show-cancel-button",
"description": "Sets the behavior for the cancel button. Defaults to `\"never\"`.\nSetting to `\"focus\"` shows the cancel button on focus.\nSetting to `\"never\"` hides the cancel button.\nSetting to `\"always\"` shows the cancel button regardless\nof focus state.",
"values": [
{
"name": "always"
},
{
"name": "focus"
},
{
"name": "never"
}
]
},
{
"name": "show-clear-button",
"description": "Sets the behavior for the clear button. Defaults to `\"focus\"`.\nSetting to `\"focus\"` shows the clear button on focus if the\ninput is not empty.\nSetting to `\"never\"` hides the clear button.\nSetting to `\"always\"` shows the clear button regardless\nof focus state, but only if the input is not empty.",
"values": [
{
"name": "always"
},
{
"name": "focus"
},
{
"name": "never"
}
]
},
{
"name": "spellcheck",
"description": "If `true`, enable spellcheck on the input."
},
{
"name": "type",
"description": "Set the type of the input.",
"values": [
{
"name": "email"
},
{
"name": "number"
},
{
"name": "password"
},
{
"name": "search"
},
{
"name": "tel"
},
{
"name": "text"
},
{
"name": "url"
}
]
},
{
"name": "value",
"description": "the value of the searchbar."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/searchbar/searchbar.tsx"
}
]
},
{
"name": "ion-segment",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the segment."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "scrollable",
"description": "If `true`, the segment buttons will overflow and the user can swipe to see them.\nIn addition, this will disable the gesture to drag the indicator between the buttons\nin order to swipe to see hidden buttons."
},
{
"name": "select-on-focus",
"description": "If `true`, navigating to an `ion-segment-button` with the keyboard will focus and select the element.\nIf `false`, keyboard navigation will only focus the `ion-segment-button` element."
},
{
"name": "swipe-gesture",
"description": "If `true`, users will be able to swipe between segment buttons to activate them."
},
{
"name": "value",
"description": "the value of the segment."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/segment/segment.tsx"
}
]
},
{
"name": "ion-segment-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the segment button."
},
{
"name": "layout",
"description": "Set the layout of the text and icon in the segment.",
"values": [
{
"name": "icon-bottom"
},
{
"name": "icon-end"
},
{
"name": "icon-hide"
},
{
"name": "icon-start"
},
{
"name": "icon-top"
},
{
"name": "label-hide"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "type",
"description": "The type of the button.",
"values": [
{
"name": "button"
},
{
"name": "reset"
},
{
"name": "submit"
}
]
},
{
"name": "value",
"description": "The value of the segment button."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/segment-button/segment-button.tsx"
}
]
},
{
"name": "ion-select",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "cancel-text",
"description": "The text to display on the cancel button."
},
{
"name": "compare-with",
"description": "A property name or function used to compare object values"
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the select."
},
{
"name": "interface",
"description": "The interface the select should use: `action-sheet`, `popover` or `alert`.",
"values": [
{
"name": "action-sheet"
},
{
"name": "alert"
},
{
"name": "popover"
}
]
},
{
"name": "interface-options",
"description": "Any additional options that the `alert`, `action-sheet` or `popover` interface\ncan take. See the [ion-alert docs](./alert), the\n[ion-action-sheet docs](./action-sheet) and the\n[ion-popover docs](./popover) for the\ncreate options for each interface.\n\nNote: `interfaceOptions` will not override `inputs` or `buttons` with the `alert` interface."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "multiple",
"description": "If `true`, the select can accept multiple values."
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "ok-text",
"description": "The text to display on the ok button."
},
{
"name": "placeholder",
"description": "The text to display when the select is empty."
},
{
"name": "selected-text",
"description": "The text to display instead of the selected option's value."
},
{
"name": "value",
"description": "the value of the select."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/select/select.tsx"
}
]
},
{
"name": "ion-select-option",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the select option. This property does not apply when `interface=\"action-sheet\"` as `ion-action-sheet` does not allow for disabled buttons."
},
{
"name": "value",
"description": "The text value of the option."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/select-option/select-option.tsx"
}
]
},
{
"name": "ion-skeleton-text",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the skeleton text will animate."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/skeleton-text/skeleton-text.tsx"
}
]
},
{
"name": "ion-slide",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/slide/slide.tsx"
}
]
},
{
"name": "ion-slides",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "options",
"description": "Options to pass to the swiper instance.\nSee https://swiperjs.com/swiper-api for valid options"
},
{
"name": "pager",
"description": "If `true`, show the pagination."
},
{
"name": "scrollbar",
"description": "If `true`, show the scrollbar."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/slides/slides.tsx"
}
]
},
{
"name": "ion-spinner",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "duration",
"description": "Duration of the spinner animation in milliseconds. The default varies based on the spinner."
},
{
"name": "name",
"description": "The name of the SVG spinner to use. If a name is not provided, the platform's default\nspinner will be used.",
"values": [
{
"name": "bubbles"
},
{
"name": "circles"
},
{
"name": "circular"
},
{
"name": "crescent"
},
{
"name": "dots"
},
{
"name": "lines"
},
{
"name": "lines-sharp"
},
{
"name": "lines-sharp-small"
},
{
"name": "lines-small"
}
]
},
{
"name": "paused",
"description": "If `true`, the spinner's animation will be paused."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/spinner/spinner.tsx"
}
]
},
{
"name": "ion-split-pane",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "content-id",
"description": "The `id` of the main content. When using\na router this is typically `ion-router-outlet`.\nWhen not using a router, this is typically\nyour main view's `ion-content`. This is not the\nid of the `ion-content` inside of your `ion-menu`."
},
{
"name": "disabled",
"description": "If `true`, the split pane will be hidden."
},
{
"name": "when",
"description": "When the split-pane should be shown.\nCan be a CSS media query expression, or a shortcut expression.\nCan also be a boolean expression."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/split-pane/split-pane.tsx"
}
]
},
{
"name": "ion-tab",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "component",
"description": "The component to display inside of the tab."
},
{
"name": "tab",
"description": "A tab id must be provided for each `ion-tab`. It's used internally to reference\nthe selected tab or by the router to switch between them."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/tab/tab.tsx"
}
]
},
{
"name": "ion-tab-bar",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "selected-tab",
"description": "The selected tab component"
},
{
"name": "translucent",
"description": "If `true`, the tab bar will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/tab-bar/tab-bar.tsx"
}
]
},
{
"name": "ion-tab-button",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the tab button."
},
{
"name": "download",
"description": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
},
{
"name": "href",
"description": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
},
{
"name": "layout",
"description": "Set the layout of the text and icon in the tab bar.\nIt defaults to `'icon-top'`.",
"values": [
{
"name": "icon-bottom"
},
{
"name": "icon-end"
},
{
"name": "icon-hide"
},
{
"name": "icon-start"
},
{
"name": "icon-top"
},
{
"name": "label-hide"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "rel",
"description": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
},
{
"name": "selected",
"description": "The selected tab component"
},
{
"name": "tab",
"description": "A tab id must be provided for each `ion-tab`. It's used internally to reference\nthe selected tab or by the router to switch between them."
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/tab-button/tab-button.tsx"
}
]
},
{
"name": "ion-tabs",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/tabs/tabs.tsx"
}
]
},
{
"name": "ion-text",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/text/text.tsx"
}
]
},
{
"name": "ion-textarea",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "auto-grow",
"description": "If `true`, the textarea container will grow and shrink based\non the contents of the textarea."
},
{
"name": "autocapitalize",
"description": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: `\"off\"`, `\"none\"`, `\"on\"`, `\"sentences\"`, `\"words\"`, `\"characters\"`."
},
{
"name": "autofocus",
"description": "This Boolean attribute lets you specify that a form control should have input focus when the page loads."
},
{
"name": "clear-on-edit",
"description": "If `true`, the value will be cleared after focus upon edit. Defaults to `true` when `type` is `\"password\"`, `false` for all other types."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "cols",
"description": "The visible width of the text control, in average character widths. If it is specified, it must be a positive integer."
},
{
"name": "debounce",
"description": "Set the amount of time, in milliseconds, to wait to trigger the `ionChange` event after each keystroke. This also impacts form bindings such as `ngModel` or `v-model`."
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the textarea."
},
{
"name": "enterkeyhint",
"description": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`.",
"values": [
{
"name": "done"
},
{
"name": "enter"
},
{
"name": "go"
},
{
"name": "next"
},
{
"name": "previous"
},
{
"name": "search"
},
{
"name": "send"
}
]
},
{
"name": "inputmode",
"description": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
"values": [
{
"name": "decimal"
},
{
"name": "email"
},
{
"name": "none"
},
{
"name": "numeric"
},
{
"name": "search"
},
{
"name": "tel"
},
{
"name": "text"
},
{
"name": "url"
}
]
},
{
"name": "maxlength",
"description": "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."
},
{
"name": "minlength",
"description": "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."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "placeholder",
"description": "Instructional text that shows before the input has a value."
},
{
"name": "readonly",
"description": "If `true`, the user cannot modify the value."
},
{
"name": "required",
"description": "If `true`, the user must fill in a value before submitting a form."
},
{
"name": "rows",
"description": "The number of visible text lines for the control."
},
{
"name": "spellcheck",
"description": "If `true`, the element will have its spelling and grammar checked."
},
{
"name": "value",
"description": "The value of the textarea."
},
{
"name": "wrap",
"description": "Indicates how the control wraps text.",
"values": [
{
"name": "hard"
},
{
"name": "off"
},
{
"name": "soft"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/textarea/textarea.tsx"
}
]
},
{
"name": "ion-thumbnail",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/thumbnail/thumbnail.tsx"
}
]
},
{
"name": "ion-title",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "size",
"description": "The size of the toolbar title.",
"values": [
{
"name": "large"
},
{
"name": "small"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/title/title.tsx"
}
]
},
{
"name": "ion-toast",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the toast will animate."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "css-class",
"description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
},
{
"name": "duration",
"description": "How many milliseconds to wait before hiding the toast. By default, it will show\nuntil `dismiss()` is called."
},
{
"name": "header",
"description": "Header to be shown in the toast."
},
{
"name": "icon",
"description": "The name of the icon to display, or the path to a valid SVG file. See `ion-icon`.\nhttps://ionic.io/ionicons"
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
},
{
"name": "layout",
"description": "Defines how the message and buttons are laid out in the toast.\n'baseline': The message and the buttons will appear on the same line.\nMessage text may wrap within the message container.\n'stacked': The buttons containers and message will stack on top\nof each other. Use this if you have long text in your buttons.",
"values": [
{
"name": "baseline"
},
{
"name": "stacked"
}
]
},
{
"name": "message",
"description": "Message to be shown in the toast.\nThis property accepts custom HTML as a string.\nDevelopers who only want to pass plain text\ncan disable the custom HTML functionality\nby setting `innerHTMLTemplatesEnabled: false` in the Ionic config."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "position",
"description": "The position of the toast on the screen.",
"values": [
{
"name": "bottom"
},
{
"name": "middle"
},
{
"name": "top"
}
]
},
{
"name": "translucent",
"description": "If `true`, the toast will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/toast/toast.tsx"
}
]
},
{
"name": "ion-toggle",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "checked",
"description": "If `true`, the toggle is selected."
},
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the toggle."
},
{
"name": "enable-on-off-labels",
"description": "Enables the on/off accessibility switch labels within the toggle."
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
},
{
"name": "name",
"description": "The name of the control, which is submitted with the form data."
},
{
"name": "value",
"description": "The value of the toggle does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a toggle is analogous to the value of a `<input type=\"checkbox\">`,\nit's only used when the toggle participates in a native `<form>`."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/toggle/toggle.tsx"
}
]
},
{
"name": "ion-toolbar",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "color",
"description": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics).",
"values": [
{
"name": "danger"
},
{
"name": "dark"
},
{
"name": "light"
},
{
"name": "medium"
},
{
"name": "primary"
},
{
"name": "secondary"
},
{
"name": "success"
},
{
"name": "tertiary"
},
{
"name": "warning"
}
]
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"values": [
{
"name": "ios"
},
{
"name": "md"
}
]
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/toolbar/toolbar.tsx"
}
]
},
{
"name": "ion-virtual-scroll",
"description": {
"kind": "markdown",
"value": ""
},
"attributes": [
{
"name": "approx-footer-height",
"description": "The approximate width of each footer template's cell.\nThis dimension is used to help determine how many cells should\nbe created when initialized, and to help calculate the height of\nthe scrollable area. This height value can only use `px` units.\nNote that the actual rendered size of each cell comes from the\napp's CSS, whereas this approximation is used to help calculate\ninitial dimensions before the item has been rendered."
},
{
"name": "approx-header-height",
"description": "The approximate height of each header template's cell.\nThis dimension is used to help determine how many cells should\nbe created when initialized, and to help calculate the height of\nthe scrollable area. This height value can only use `px` units.\nNote that the actual rendered size of each cell comes from the\napp's CSS, whereas this approximation is used to help calculate\ninitial dimensions before the item has been rendered."
},
{
"name": "approx-item-height",
"description": "It is important to provide this\nif virtual item height will be significantly larger than the default\nThe approximate height of each virtual item template's cell.\nThis dimension is used to help determine how many cells should\nbe created when initialized, and to help calculate the height of\nthe scrollable area. This height value can only use `px` units.\nNote that the actual rendered size of each cell comes from the\napp's CSS, whereas this approximation is used to help calculate\ninitial dimensions before the item has been rendered."
}
],
"references": [
{
"name": "Source code",
"url": "./https:/github.com/ionic-team/ionic/tree/main/core/src/components/virtual-scroll/virtual-scroll.tsx"
}
]
}
]
}