@ionic/vue
Version:
Vue specific wrapper for @ionic/core
1,308 lines • 306 kB
JSON
{
"$schema": "http://json.schemastore.org/web-types",
"framework": "vue",
"name": "@ionic/vue",
"version": "6.4.5",
"contributions": {
"html": {
"types-syntax": "typescript",
"description-markup": "markdown",
"tags": [
{
"name": "IonAccordion",
"doc-url": "https://ionicframework.com/docs/api/accordion",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/accordion/accordion.d.ts",
"symbol": "Accordion"
},
"attributes": [
{
"name": "disabled",
"description": "If `true`, the accordion cannot be interacted with.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
},
{
"name": "readonly",
"description": "If `true`, the accordion cannot be interacted with,\nbut does not alter the opacity.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "toggle-icon",
"description": "The toggle icon to use. This icon will be\nrotated when the accordion is expanded\nor collapsed.",
"required": false,
"default": "chevronDown",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"name": "toggle-icon-slot",
"description": "The slot inside of `ion-item` to\nplace the toggle icon. Defaults to `'end'`.",
"required": false,
"default": "'end'",
"value": {
"kind": "expression",
"type": "\"end\" | \"start\""
}
},
{
"name": "value",
"description": "The value of the accordion. Defaults to an autogenerated\nvalue.",
"required": false,
"default": "`ion-accordion-${accordionIds++}`",
"value": {
"kind": "expression",
"type": "string"
}
}
],
"slots": [
{
"name": "content",
"description": "Content is placed below the header and is\nshown or hidden based on expanded state."
},
{
"name": "header",
"description": "Content is placed at the top and is used to\nexpand or collapse the accordion item."
}
],
"events": []
},
{
"name": "IonAccordionGroup",
"doc-url": "https://ionicframework.com/docs/api/accordion-group",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/accordion-group/accordion-group.d.ts",
"symbol": "AccordionGroup"
},
"attributes": [
{
"name": "animated",
"description": "If `true`, all accordions inside of the\naccordion group will animate when expanding\nor collapsing.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "disabled",
"description": "If `true`, the accordion group cannot be interacted with.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "expand",
"description": "Describes the expansion behavior for each accordion.\nPossible values are `\"compact\"` and `\"inset\"`.\nDefaults to `\"compact\"`.",
"required": false,
"default": "'compact'",
"value": {
"kind": "expression",
"type": "\"compact\" | \"inset\""
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
},
{
"name": "multiple",
"description": "If `true`, the accordion group can have multiple\naccordion components expanded at the same time.",
"required": false,
"value": {
"kind": "expression",
"type": "boolean | undefined"
}
},
{
"name": "readonly",
"description": "If `true`, the accordion group cannot be interacted with,\nbut does not alter the opacity.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "value",
"description": "The value of the accordion group.",
"required": false,
"value": {
"kind": "expression",
"type": "null | string | string[] | undefined"
}
}
],
"slots": [],
"events": [
{
"name": "ionChange",
"description": "Emitted when the value property has changed.",
"arguments": [
{
"name": "detail",
"type": "AccordionGroupChangeEventDetail<any>"
}
]
}
]
},
{
"name": "IonActionSheet",
"doc-url": "https://ionicframework.com/docs/api/action-sheet",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/action-sheet/action-sheet.d.ts",
"symbol": "ActionSheet"
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the action sheet will animate.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the action sheet will be dismissed when the backdrop is clicked.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "buttons",
"description": "An array of buttons for the action sheet.",
"required": false,
"default": "[]",
"value": {
"kind": "expression",
"type": "(string | ActionSheetButton<any>)[]"
}
},
{
"name": "css-class",
"description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces.",
"required": false,
"value": {
"kind": "expression",
"type": "string | string[] | undefined"
}
},
{
"name": "enterAnimation",
"description": "Animation to use when the action sheet is presented.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"name": "header",
"description": "Title for the action sheet.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "htmlAttributes",
"description": "Additional attributes to pass to the action sheet.",
"required": false,
"value": {
"kind": "expression",
"type": "undefined | { [key: string]: any; }"
}
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "leaveAnimation",
"description": "Animation to use when the action sheet is dismissed.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
},
{
"name": "sub-header",
"description": "Subtitle for the action sheet.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"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).",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"slots": [],
"events": [
{
"name": "onDidDismiss",
"description": "Emitted after the alert has dismissed.",
"arguments": [
{
"name": "detail",
"type": "OverlayEventDetail<any>"
}
]
},
{
"name": "onDidPresent",
"description": "Emitted after the alert has presented.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
},
{
"name": "onWillDismiss",
"description": "Emitted before the alert has dismissed.",
"arguments": [
{
"name": "detail",
"type": "OverlayEventDetail<any>"
}
]
},
{
"name": "onWillPresent",
"description": "Emitted before the alert has presented.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
}
]
},
{
"name": "IonAlert",
"doc-url": "https://ionicframework.com/docs/api/alert",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/alert/alert.d.ts",
"symbol": "Alert"
},
"attributes": [
{
"name": "animated",
"description": "If `true`, the alert will animate.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "backdrop-dismiss",
"description": "If `true`, the alert will be dismissed when the backdrop is clicked.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "buttons",
"description": "Array of buttons to be added to the alert.",
"required": false,
"default": "[]",
"value": {
"kind": "expression",
"type": "(string | AlertButton)[]"
}
},
{
"name": "css-class",
"description": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces.",
"required": false,
"value": {
"kind": "expression",
"type": "string | string[] | undefined"
}
},
{
"name": "enterAnimation",
"description": "Animation to use when the alert is presented.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"name": "header",
"description": "The main title in the heading of the alert.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "htmlAttributes",
"description": "Additional attributes to pass to the alert.",
"required": false,
"value": {
"kind": "expression",
"type": "undefined | { [key: string]: any; }"
}
},
{
"name": "inputs",
"description": "Array of input to show in the alert.",
"required": false,
"default": "[]",
"value": {
"kind": "expression",
"type": "AlertInput[]"
}
},
{
"name": "keyboard-close",
"description": "If `true`, the keyboard will be automatically dismissed when the overlay is presented.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "leaveAnimation",
"description": "Animation to use when the alert is dismissed.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"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)",
"required": false,
"value": {
"kind": "expression",
"type": "IonicSafeString | string | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
},
{
"name": "sub-header",
"description": "The subtitle in the heading of the alert. Displayed under the title.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"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).",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"slots": [],
"events": [
{
"name": "onDidDismiss",
"description": "Emitted after the alert has dismissed.",
"arguments": [
{
"name": "detail",
"type": "OverlayEventDetail<any>"
}
]
},
{
"name": "onDidPresent",
"description": "Emitted after the alert has presented.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
},
{
"name": "onWillDismiss",
"description": "Emitted before the alert has dismissed.",
"arguments": [
{
"name": "detail",
"type": "OverlayEventDetail<any>"
}
]
},
{
"name": "onWillPresent",
"description": "Emitted before the alert has presented.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
}
]
},
{
"name": "IonAvatar",
"doc-url": "https://ionicframework.com/docs/api/avatar",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/avatar/avatar.d.ts",
"symbol": "Avatar"
},
"attributes": [],
"slots": [],
"events": []
},
{
"name": "IonBackButton",
"doc-url": "https://ionicframework.com/docs/api/back-button",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/back-button/back-button.d.ts",
"symbol": "BackButton"
},
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined"
}
},
{
"name": "default-href",
"description": "The url to navigate back to by default when there is no history.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the button.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "icon",
"description": "The built-in named SVG icon name or the exact `src` of an SVG file\nto use for the back button.",
"required": false,
"value": {
"kind": "expression",
"type": "null | string | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
},
{
"name": "routerAnimation",
"description": "When using a router, it specifies the transition animation when navigating to\nanother page.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"name": "text",
"description": "The text to display in the back button.",
"required": false,
"value": {
"kind": "expression",
"type": "null | string | undefined"
}
},
{
"name": "type",
"description": "The type of the button.",
"required": false,
"default": "'button'",
"value": {
"kind": "expression",
"type": "\"button\" | \"reset\" | \"submit\""
}
}
],
"slots": [],
"events": []
},
{
"name": "IonBackdrop",
"doc-url": "https://ionicframework.com/docs/api/backdrop",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/backdrop/backdrop.d.ts",
"symbol": "Backdrop"
},
"attributes": [
{
"name": "stop-propagation",
"description": "If `true`, the backdrop will stop propagation on tap.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "tappable",
"description": "If `true`, the backdrop will can be clicked and will emit the `ionBackdropTap` event.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "visible",
"description": "If `true`, the backdrop will be visible.",
"required": false,
"default": "true",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"slots": [],
"events": [
{
"name": "onTap",
"description": "Emitted when the backdrop is tapped.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
}
]
},
{
"name": "IonBadge",
"doc-url": "https://ionicframework.com/docs/api/badge",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/badge/badge.d.ts",
"symbol": "Badge"
},
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
}
],
"slots": [],
"events": []
},
{
"name": "IonBreadcrumb",
"doc-url": "https://ionicframework.com/docs/api/breadcrumb",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/breadcrumb/breadcrumb.d.ts",
"symbol": "Breadcrumb"
},
"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.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined"
}
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the breadcrumb.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"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.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"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).",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "routerAnimation",
"description": "When using a router, it specifies the transition animation when navigating to\nanother page using `href`.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"required": false,
"default": "'forward'",
"value": {
"kind": "expression",
"type": "\"back\" | \"forward\" | \"root\""
}
},
{
"name": "separator",
"description": "If true, show a separator between this breadcrumb and the next.\nDefaults to `true` for all breadcrumbs except the last.",
"required": false,
"value": {
"kind": "expression",
"type": "boolean | undefined"
}
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
}
],
"slots": [],
"events": [
{
"name": "ionBlur",
"description": "Emitted when the breadcrumb loses focus.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
},
{
"name": "ionFocus",
"description": "Emitted when the breadcrumb has focus.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
}
]
},
{
"name": "IonBreadcrumbs",
"doc-url": "https://ionicframework.com/docs/api/breadcrumbs",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/breadcrumbs/breadcrumbs.d.ts",
"symbol": "Breadcrumbs"
},
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined"
}
},
{
"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.",
"required": false,
"default": "1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"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.",
"required": false,
"default": "1",
"value": {
"kind": "expression",
"type": "number"
}
},
{
"name": "max-items",
"description": "The maximum number of breadcrumbs to show before collapsing.",
"required": false,
"value": {
"kind": "expression",
"type": "number | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
}
],
"slots": [],
"events": [
{
"name": "ionCollapsedClick",
"description": "Emitted when the collapsed indicator is clicked on.",
"arguments": [
{
"name": "detail",
"type": "BreadcrumbCollapsedClickEventDetail"
}
]
}
]
},
{
"name": "IonButton",
"doc-url": "https://ionicframework.com/docs/api/button",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/button/button.d.ts",
"symbol": "Button"
},
"attributes": [
{
"name": "button-type",
"description": "The type of button.",
"required": false,
"default": "'button'",
"value": {
"kind": "expression",
"type": "string"
}
},
{
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined"
}
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the button.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"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.",
"required": false,
"value": {
"kind": "expression",
"type": "\"block\" | \"full\" | undefined"
}
},
{
"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\"`.",
"required": false,
"value": {
"kind": "expression",
"type": "\"clear\" | \"default\" | \"outline\" | \"solid\" | undefined"
}
},
{
"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.",
"required": false,
"value": {
"kind": "expression",
"type": "HTMLFormElement | string | undefined"
}
},
{
"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.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"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).",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "routerAnimation",
"description": "When using a router, it specifies the transition animation when navigating to\nanother page using `href`.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"required": false,
"default": "'forward'",
"value": {
"kind": "expression",
"type": "\"back\" | \"forward\" | \"root\""
}
},
{
"name": "shape",
"description": "Set to `\"round\"` for a button with more rounded corners.",
"required": false,
"value": {
"kind": "expression",
"type": "\"round\" | undefined"
}
},
{
"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.",
"required": false,
"value": {
"kind": "expression",
"type": "\"default\" | \"large\" | \"small\" | undefined"
}
},
{
"name": "strong",
"description": "If `true`, activates a button with a heavier font weight.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "type",
"description": "The type of the button.",
"required": false,
"default": "'button'",
"value": {
"kind": "expression",
"type": "\"button\" | \"reset\" | \"submit\""
}
}
],
"slots": [
{
"name": "default",
"description": "Content is placed between the named slots if provided without a slot."
},
{
"name": "end",
"description": "Content is placed to the right of the button text in LTR, and to the left in RTL."
},
{
"name": "icon-only",
"description": "Should be used on an icon in a button that has no text."
},
{
"name": "start",
"description": "Content is placed to the left of the button text in LTR, and to the right in RTL."
}
],
"events": [
{
"name": "ionBlur",
"description": "Emitted when the button loses focus.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
},
{
"name": "ionFocus",
"description": "Emitted when the button has focus.",
"arguments": [
{
"name": "detail",
"type": "void"
}
]
}
]
},
{
"name": "IonButtons",
"doc-url": "https://ionicframework.com/docs/api/buttons",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/buttons/buttons.d.ts",
"symbol": "Buttons"
},
"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)",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
}
],
"slots": [],
"events": []
},
{
"name": "IonCard",
"doc-url": "https://ionicframework.com/docs/api/card",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/card/card.d.ts",
"symbol": "Card"
},
"attributes": [
{
"name": "button",
"description": "If `true`, a button tag will be rendered and the card will be tappable.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "\"danger\" | \"dark\" | \"light\" | \"medium\" | \"primary\" | \"secondary\" | \"success\" | \"tertiary\" | \"warning\" | string & Record<never, never> | undefined"
}
},
{
"name": "disabled",
"description": "If `true`, the user cannot interact with the card.",
"required": false,
"default": "false",
"value": {
"kind": "expression",
"type": "boolean"
}
},
{
"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).",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"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.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"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).",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "routerAnimation",
"description": "When using a router, it specifies the transition animation when navigating to\nanother page using `href`.",
"required": false,
"value": {
"kind": "expression",
"type": "((baseEl: any, opts?: any) => Animation) | undefined"
}
},
{
"name": "router-direction",
"description": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`.",
"required": false,
"default": "'forward'",
"value": {
"kind": "expression",
"type": "\"back\" | \"forward\" | \"root\""
}
},
{
"name": "target",
"description": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`.",
"required": false,
"value": {
"kind": "expression",
"type": "string | undefined"
}
},
{
"name": "type",
"description": "The type of the button. Only used when an `onclick` or `button` property is present.",
"required": false,
"default": "'button'",
"value": {
"kind": "expression",
"type": "\"button\" | \"reset\" | \"submit\""
}
}
],
"slots": [],
"events": []
},
{
"name": "IonCardContent",
"doc-url": "https://ionicframework.com/docs/api/card-content",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/card-content/card-content.d.ts",
"symbol": "CardContent"
},
"attributes": [
{
"name": "mode",
"description": "The mode determines which platform styles to use.",
"required": false,
"value": {
"kind": "expression",
"type": "\"ios\" | \"md\""
}
}
],
"slots": [],
"events": []
},
{
"name": "IonCardHeader",
"doc-url": "https://ionicframework.com/docs/api/card-header",
"description": "",
"source": {
"module": "@ionic/core/dist/types/components/card-header/card-header.d.ts",
"symbol": "CardHeader"
},
"attributes": [
{
"name": "color",
"descript