UNPKG

@ionic/core

Version:
1,609 lines • 1.08 MB
{ "timestamp": "2025-04-02T15:46:25", "compiler": { "name": "@stencil/core", "version": "4.20.0", "typescriptVersion": "5.5.3" }, "components": [ { "filePath": "src/components/accordion/accordion.tsx", "encapsulation": "shadow", "tag": "ion-accordion", "docs": "", "docsTags": [ { "name": "virtualProp", "text": "{\"ios\" | \"md\"} mode - The mode determines which platform styles to use." }, { "name": "slot", "text": "header - Content is placed at the top and is used to\nexpand or collapse the accordion item." }, { "name": "slot", "text": "content - Content is placed below the header and is\nshown or hidden based on expanded state." }, { "name": "part", "text": "header - The wrapper element for the header slot." }, { "name": "part", "text": "content - The wrapper element for the content slot." }, { "name": "part", "text": "expanded - The expanded element. Can be used in combination\nwith the `header` and `content` parts (i.e. `::part(header expanded)`)." } ], "usage": {}, "props": [ { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "If `true`, the accordion cannot be interacted with.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "mode", "type": "\"ios\" | \"md\"", "mutable": false, "attr": "mode", "reflectToAttr": false, "docs": "The mode determines which platform styles to use.", "docsTags": [], "values": [ { "value": "ios", "type": "string" }, { "value": "md", "type": "string" } ], "optional": true, "required": false }, { "name": "readonly", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "readonly", "reflectToAttr": false, "docs": "If `true`, the accordion cannot be interacted with,\nbut does not alter the opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "toggleIcon", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "toggle-icon", "reflectToAttr": false, "docs": "The toggle icon to use. This icon will be\nrotated when the accordion is expanded\nor collapsed.", "docsTags": [], "default": "chevronDown", "values": [ { "type": "string" } ], "optional": false, "required": false }, { "name": "toggleIconSlot", "type": "\"end\" | \"start\"", "complexType": { "original": "'start' | 'end'", "resolved": "\"end\" | \"start\"", "references": {} }, "mutable": false, "attr": "toggle-icon-slot", "reflectToAttr": false, "docs": "The slot inside of `ion-item` to\nplace the toggle icon. Defaults to `\"end\"`.", "docsTags": [], "default": "'end'", "values": [ { "value": "end", "type": "string" }, { "value": "start", "type": "string" } ], "optional": false, "required": false }, { "name": "value", "type": "string", "complexType": { "original": "string", "resolved": "string", "references": {} }, "mutable": false, "attr": "value", "reflectToAttr": false, "docs": "The value of the accordion. Defaults to an autogenerated\nvalue.", "docsTags": [], "default": "`ion-accordion-${accordionIds++}`", "values": [ { "type": "string" } ], "optional": false, "required": false } ], "methods": [], "events": [], "listeners": [], "styles": [], "slots": [ { "name": "content", "docs": "Content is placed below the header and is\nshown or hidden based on expanded state." }, { "name": "header", "docs": "Content is placed at the top and is used to\nexpand or collapse the accordion item." } ], "parts": [ { "name": "content", "docs": "The wrapper element for the content slot." }, { "name": "expanded", "docs": "The expanded element. Can be used in combination\nwith the `header` and `content` parts (i.e. `::part(header expanded)`)." }, { "name": "header", "docs": "The wrapper element for the header slot." } ], "dependents": [], "dependencies": [ "ion-icon" ], "dependencyGraph": { "ion-accordion": [ "ion-icon" ] } }, { "filePath": "src/components/accordion-group/accordion-group.tsx", "encapsulation": "shadow", "tag": "ion-accordion-group", "docs": "", "docsTags": [ { "name": "virtualProp", "text": "{\"ios\" | \"md\"} mode - The mode determines which platform styles to use." } ], "usage": {}, "props": [ { "name": "animated", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "animated", "reflectToAttr": false, "docs": "If `true`, all accordions inside of the\naccordion group will animate when expanding\nor collapsing.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "disabled", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "disabled", "reflectToAttr": false, "docs": "If `true`, the accordion group cannot be interacted with.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "expand", "type": "\"compact\" | \"inset\"", "complexType": { "original": "'compact' | 'inset'", "resolved": "\"compact\" | \"inset\"", "references": {} }, "mutable": false, "attr": "expand", "reflectToAttr": false, "docs": "Describes the expansion behavior for each accordion.\nPossible values are `\"compact\"` and `\"inset\"`.\nDefaults to `\"compact\"`.", "docsTags": [], "default": "'compact'", "values": [ { "value": "compact", "type": "string" }, { "value": "inset", "type": "string" } ], "optional": false, "required": false }, { "name": "mode", "type": "\"ios\" | \"md\"", "mutable": false, "attr": "mode", "reflectToAttr": false, "docs": "The mode determines which platform styles to use.", "docsTags": [], "values": [ { "value": "ios", "type": "string" }, { "value": "md", "type": "string" } ], "optional": true, "required": false }, { "name": "multiple", "type": "boolean | undefined", "complexType": { "original": "boolean", "resolved": "boolean | undefined", "references": {} }, "mutable": false, "attr": "multiple", "reflectToAttr": false, "docs": "If `true`, the accordion group can have multiple\naccordion components expanded at the same time.", "docsTags": [], "values": [ { "type": "boolean" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "readonly", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "readonly", "reflectToAttr": false, "docs": "If `true`, the accordion group cannot be interacted with,\nbut does not alter the opacity.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "value", "type": "null | string | string[] | undefined", "complexType": { "original": "string | string[] | null", "resolved": "null | string | string[] | undefined", "references": {} }, "mutable": true, "attr": "value", "reflectToAttr": false, "docs": "The value of the accordion group. This controls which\naccordions are expanded.\nThis should be an array of strings only when `multiple=\"true\"`", "docsTags": [], "values": [ { "type": "null" }, { "type": "string" }, { "type": "string[]" }, { "type": "undefined" } ], "optional": true, "required": false } ], "methods": [], "events": [ { "event": "ionChange", "detail": "AccordionGroupChangeEventDetail<any>", "bubbles": true, "complexType": { "original": "AccordionGroupChangeEventDetail", "resolved": "AccordionGroupChangeEventDetail<any>", "references": { "AccordionGroupChangeEventDetail": { "location": "import", "path": "./accordion-group-interface", "id": "src/components/accordion-group/accordion-group-interface.ts::AccordionGroupChangeEventDetail" } } }, "cancelable": true, "composed": true, "docs": "Emitted when the value property has changed as a result of a user action such as a click.\n\nThis event will not emit when programmatically setting the `value` property.", "docsTags": [] } ], "listeners": [ { "event": "keydown", "capture": false, "passive": false } ], "styles": [], "slots": [], "parts": [], "dependents": [], "dependencies": [], "dependencyGraph": {} }, { "filePath": "src/components/action-sheet/action-sheet.tsx", "encapsulation": "scoped", "tag": "ion-action-sheet", "docs": "", "docsTags": [ { "name": "virtualProp", "text": "{\"ios\" | \"md\"} mode - The mode determines which platform styles to use." } ], "usage": {}, "props": [ { "name": "animated", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "animated", "reflectToAttr": false, "docs": "If `true`, the action sheet will animate.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "backdropDismiss", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "backdrop-dismiss", "reflectToAttr": false, "docs": "If `true`, the action sheet will be dismissed when the backdrop is clicked.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "buttons", "type": "(string | ActionSheetButton<any>)[]", "complexType": { "original": "(ActionSheetButton | string)[]", "resolved": "(string | ActionSheetButton<any>)[]", "references": { "ActionSheetButton": { "location": "import", "path": "./action-sheet-interface", "id": "src/components/action-sheet/action-sheet-interface.ts::ActionSheetButton" } } }, "mutable": false, "reflectToAttr": false, "docs": "An array of buttons for the action sheet.", "docsTags": [], "default": "[]", "values": [ { "type": "(string" }, { "type": "ActionSheetButton<any>)[]" } ], "optional": false, "required": false }, { "name": "cssClass", "type": "string | string[] | undefined", "complexType": { "original": "string | string[]", "resolved": "string | string[] | undefined", "references": {} }, "mutable": false, "attr": "css-class", "reflectToAttr": false, "docs": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces.", "docsTags": [], "values": [ { "type": "string" }, { "type": "string[]" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "enterAnimation", "type": "((baseEl: any, opts?: any) => Animation) | undefined", "complexType": { "original": "AnimationBuilder", "resolved": "((baseEl: any, opts?: any) => Animation) | undefined", "references": { "AnimationBuilder": { "location": "import", "path": "../../interface", "id": "src/interface.d.ts::AnimationBuilder" } } }, "mutable": false, "reflectToAttr": false, "docs": "Animation to use when the action sheet is presented.", "docsTags": [], "values": [ { "type": "((baseEl: any, opts?: any) => Animation)" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "header", "type": "string | undefined", "complexType": { "original": "string", "resolved": "string | undefined", "references": {} }, "mutable": false, "attr": "header", "reflectToAttr": false, "docs": "Title for the action sheet.", "docsTags": [], "values": [ { "type": "string" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "htmlAttributes", "type": "undefined | { [key: string]: any; }", "complexType": { "original": "{ [key: string]: any }", "resolved": "undefined | { [key: string]: any; }", "references": {} }, "mutable": false, "reflectToAttr": false, "docs": "Additional attributes to pass to the action sheet.", "docsTags": [], "values": [ { "type": "undefined" }, { "type": "{ [key: string]: any; }" } ], "optional": true, "required": false }, { "name": "isOpen", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "is-open", "reflectToAttr": false, "docs": "If `true`, the action sheet will open. If `false`, the action sheet will close.\nUse this if you need finer grained control over presentation, otherwise\njust use the actionSheetController or the `trigger` property.\nNote: `isOpen` will not automatically be set back to `false` when\nthe action sheet dismisses. You will need to do that in your code.", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "keyboardClose", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "keyboard-close", "reflectToAttr": false, "docs": "If `true`, the keyboard will be automatically dismissed when the overlay is presented.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "leaveAnimation", "type": "((baseEl: any, opts?: any) => Animation) | undefined", "complexType": { "original": "AnimationBuilder", "resolved": "((baseEl: any, opts?: any) => Animation) | undefined", "references": { "AnimationBuilder": { "location": "import", "path": "../../interface", "id": "src/interface.d.ts::AnimationBuilder" } } }, "mutable": false, "reflectToAttr": false, "docs": "Animation to use when the action sheet is dismissed.", "docsTags": [], "values": [ { "type": "((baseEl: any, opts?: any) => Animation)" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "mode", "type": "\"ios\" | \"md\"", "mutable": false, "attr": "mode", "reflectToAttr": false, "docs": "The mode determines which platform styles to use.", "docsTags": [], "values": [ { "value": "ios", "type": "string" }, { "value": "md", "type": "string" } ], "optional": true, "required": false }, { "name": "subHeader", "type": "string | undefined", "complexType": { "original": "string", "resolved": "string | undefined", "references": {} }, "mutable": false, "attr": "sub-header", "reflectToAttr": false, "docs": "Subtitle for the action sheet.", "docsTags": [], "values": [ { "type": "string" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "translucent", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "translucent", "reflectToAttr": false, "docs": "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).", "docsTags": [], "default": "false", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "trigger", "type": "string | undefined", "complexType": { "original": "string | undefined", "resolved": "string | undefined", "references": {} }, "mutable": false, "attr": "trigger", "reflectToAttr": false, "docs": "An ID corresponding to the trigger element that\ncauses the action sheet to open when clicked.", "docsTags": [], "values": [ { "type": "string" }, { "type": "undefined" } ], "optional": false, "required": false } ], "methods": [ { "name": "dismiss", "returns": { "type": "Promise<boolean>", "docs": "" }, "complexType": { "signature": "(data?: any, role?: string) => Promise<boolean>", "parameters": [ { "name": "data", "type": "any", "docs": "Any data to emit in the dismiss events." }, { "name": "role", "type": "string | undefined", "docs": "The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method." } ], "references": { "Promise": { "location": "global", "id": "global::Promise" } }, "return": "Promise<boolean>" }, "signature": "dismiss(data?: any, role?: string) => Promise<boolean>", "parameters": [ { "name": "data", "type": "any", "docs": "Any data to emit in the dismiss events." }, { "name": "role", "type": "string | undefined", "docs": "The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method." } ], "docs": "Dismiss the action sheet overlay after it has been presented.", "docsTags": [ { "name": "param", "text": "data Any data to emit in the dismiss events." }, { "name": "param", "text": "role The role of the element that is dismissing the action sheet.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the action sheet.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`.\n\nThis is a no-op if the overlay has not been presented yet. If you want\nto remove an overlay from the DOM that was never presented, use the\n[remove](https://developer.mozilla.org/en-US/docs/Web/API/Element/remove) method." } ] }, { "name": "onDidDismiss", "returns": { "type": "Promise<OverlayEventDetail<T>>", "docs": "" }, "complexType": { "signature": "<T = any>() => Promise<OverlayEventDetail<T>>", "parameters": [], "references": { "Promise": { "location": "global", "id": "global::Promise" }, "OverlayEventDetail": { "location": "import", "path": "../../utils/overlays-interface", "id": "src/utils/overlays-interface.ts::OverlayEventDetail" }, "T": { "location": "global", "id": "global::T" } }, "return": "Promise<OverlayEventDetail<T>>" }, "signature": "onDidDismiss<T = any>() => Promise<OverlayEventDetail<T>>", "parameters": [], "docs": "Returns a promise that resolves when the action sheet did dismiss.", "docsTags": [] }, { "name": "onWillDismiss", "returns": { "type": "Promise<OverlayEventDetail<T>>", "docs": "" }, "complexType": { "signature": "<T = any>() => Promise<OverlayEventDetail<T>>", "parameters": [], "references": { "Promise": { "location": "global", "id": "global::Promise" }, "OverlayEventDetail": { "location": "import", "path": "../../utils/overlays-interface", "id": "src/utils/overlays-interface.ts::OverlayEventDetail" }, "T": { "location": "global", "id": "global::T" } }, "return": "Promise<OverlayEventDetail<T>>" }, "signature": "onWillDismiss<T = any>() => Promise<OverlayEventDetail<T>>", "parameters": [], "docs": "Returns a promise that resolves when the action sheet will dismiss.", "docsTags": [] }, { "name": "present", "returns": { "type": "Promise<void>", "docs": "" }, "complexType": { "signature": "() => Promise<void>", "parameters": [], "references": { "Promise": { "location": "global", "id": "global::Promise" } }, "return": "Promise<void>" }, "signature": "present() => Promise<void>", "parameters": [], "docs": "Present the action sheet overlay after it has been created.", "docsTags": [] } ], "events": [ { "event": "didDismiss", "detail": "OverlayEventDetail<any>", "bubbles": true, "complexType": { "original": "OverlayEventDetail", "resolved": "OverlayEventDetail<any>", "references": { "OverlayEventDetail": { "location": "import", "path": "../../utils/overlays-interface", "id": "src/utils/overlays-interface.ts::OverlayEventDetail" } } }, "cancelable": true, "composed": true, "docs": "Emitted after the action sheet has dismissed.\nShorthand for ionActionSheetDidDismiss.", "docsTags": [] }, { "event": "didPresent", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted after the action sheet has presented.\nShorthand for ionActionSheetWillDismiss.", "docsTags": [] }, { "event": "ionActionSheetDidDismiss", "detail": "OverlayEventDetail<any>", "bubbles": true, "complexType": { "original": "OverlayEventDetail", "resolved": "OverlayEventDetail<any>", "references": { "OverlayEventDetail": { "location": "import", "path": "../../utils/overlays-interface", "id": "src/utils/overlays-interface.ts::OverlayEventDetail" } } }, "cancelable": true, "composed": true, "docs": "Emitted after the action sheet has dismissed.", "docsTags": [] }, { "event": "ionActionSheetDidPresent", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted after the action sheet has presented.", "docsTags": [] }, { "event": "ionActionSheetWillDismiss", "detail": "OverlayEventDetail<any>", "bubbles": true, "complexType": { "original": "OverlayEventDetail", "resolved": "OverlayEventDetail<any>", "references": { "OverlayEventDetail": { "location": "import", "path": "../../utils/overlays-interface", "id": "src/utils/overlays-interface.ts::OverlayEventDetail" } } }, "cancelable": true, "composed": true, "docs": "Emitted before the action sheet has dismissed.", "docsTags": [] }, { "event": "ionActionSheetWillPresent", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted before the action sheet has presented.", "docsTags": [] }, { "event": "willDismiss", "detail": "OverlayEventDetail<any>", "bubbles": true, "complexType": { "original": "OverlayEventDetail", "resolved": "OverlayEventDetail<any>", "references": { "OverlayEventDetail": { "location": "import", "path": "../../utils/overlays-interface", "id": "src/utils/overlays-interface.ts::OverlayEventDetail" } } }, "cancelable": true, "composed": true, "docs": "Emitted before the action sheet has dismissed.\nShorthand for ionActionSheetWillDismiss.", "docsTags": [] }, { "event": "willPresent", "detail": "void", "bubbles": true, "complexType": { "original": "void", "resolved": "void", "references": {} }, "cancelable": true, "composed": true, "docs": "Emitted before the action sheet has presented.\nShorthand for ionActionSheetWillPresent.", "docsTags": [] } ], "listeners": [], "styles": [ { "name": "--backdrop-opacity", "annotation": "prop", "docs": "Opacity of the backdrop", "mode": "ios" }, { "name": "--backdrop-opacity", "annotation": "prop", "docs": "Opacity of the backdrop", "mode": "md" }, { "name": "--background", "annotation": "prop", "docs": "Background of the action sheet group", "mode": "ios" }, { "name": "--background", "annotation": "prop", "docs": "Background of the action sheet group", "mode": "md" }, { "name": "--button-background", "annotation": "prop", "docs": "Background of the action sheet button", "mode": "ios" }, { "name": "--button-background", "annotation": "prop", "docs": "Background of the action sheet button", "mode": "md" }, { "name": "--button-background-activated", "annotation": "prop", "docs": "Background of the action sheet button when pressed. Note: setting this will interfere with the Material Design ripple.", "mode": "ios" }, { "name": "--button-background-activated", "annotation": "prop", "docs": "Background of the action sheet button when pressed. Note: setting this will interfere with the Material Design ripple.", "mode": "md" }, { "name": "--button-background-activated-opacity", "annotation": "prop", "docs": "Opacity of the action sheet button background when pressed", "mode": "ios" }, { "name": "--button-background-activated-opacity", "annotation": "prop", "docs": "Opacity of the action sheet button background when pressed", "mode": "md" }, { "name": "--button-background-focused", "annotation": "prop", "docs": "Background of the action sheet button when tabbed to", "mode": "ios" }, { "name": "--button-background-focused", "annotation": "prop", "docs": "Background of the action sheet button when tabbed to", "mode": "md" }, { "name": "--button-background-focused-opacity", "annotation": "prop", "docs": "Opacity of the action sheet button background when tabbed to", "mode": "ios" }, { "name": "--button-background-focused-opacity", "annotation": "prop", "docs": "Opacity of the action sheet button background when tabbed to", "mode": "md" }, { "name": "--button-background-hover", "annotation": "prop", "docs": "Background of the action sheet button on hover", "mode": "ios" }, { "name": "--button-background-hover", "annotation": "prop", "docs": "Background of the action sheet button on hover", "mode": "md" }, { "name": "--button-background-hover-opacity", "annotation": "prop", "docs": "Opacity of the action sheet button background on hover", "mode": "ios" }, { "name": "--button-background-hover-opacity", "annotation": "prop", "docs": "Opacity of the action sheet button background on hover", "mode": "md" }, { "name": "--button-background-selected", "annotation": "prop", "docs": "Background of the selected action sheet button", "mode": "ios" }, { "name": "--button-background-selected", "annotation": "prop", "docs": "Background of the selected action sheet button", "mode": "md" }, { "name": "--button-background-selected-opacity", "annotation": "prop", "docs": "Opacity of the selected action sheet button background", "mode": "ios" }, { "name": "--button-background-selected-opacity", "annotation": "prop", "docs": "Opacity of the selected action sheet button background", "mode": "md" }, { "name": "--button-color", "annotation": "prop", "docs": "Color of the action sheet button", "mode": "ios" }, { "name": "--button-color", "annotation": "prop", "docs": "Color of the action sheet button", "mode": "md" }, { "name": "--button-color-activated", "annotation": "prop", "docs": "Color of the action sheet button when pressed", "mode": "ios" }, { "name": "--button-color-activated", "annotation": "prop", "docs": "Color of the action sheet button when pressed", "mode": "md" }, { "name": "--button-color-disabled", "annotation": "prop", "docs": "Color of the selected action sheet button when disabled", "mode": "ios" }, { "name": "--button-color-disabled", "annotation": "prop", "docs": "Color of the selected action sheet button when disabled", "mode": "md" }, { "name": "--button-color-focused", "annotation": "prop", "docs": "Color of the action sheet button when tabbed to", "mode": "ios" }, { "name": "--button-color-focused", "annotation": "prop", "docs": "Color of the action sheet button when tabbed to", "mode": "md" }, { "name": "--button-color-hover", "annotation": "prop", "docs": "Color of the action sheet button on hover", "mode": "ios" }, { "name": "--button-color-hover", "annotation": "prop", "docs": "Color of the action sheet button on hover", "mode": "md" }, { "name": "--button-color-selected", "annotation": "prop", "docs": "Color of the selected action sheet button", "mode": "ios" }, { "name": "--button-color-selected", "annotation": "prop", "docs": "Color of the selected action sheet button", "mode": "md" }, { "name": "--color", "annotation": "prop", "docs": "Color of the action sheet text", "mode": "ios" }, { "name": "--color", "annotation": "prop", "docs": "Color of the action sheet text", "mode": "md" }, { "name": "--height", "annotation": "prop", "docs": "height of the action sheet", "mode": "ios" }, { "name": "--height", "annotation": "prop", "docs": "height of the action sheet", "mode": "md" }, { "name": "--max-height", "annotation": "prop", "docs": "Maximum height of the action sheet", "mode": "ios" }, { "name": "--max-height", "annotation": "prop", "docs": "Maximum height of the action sheet", "mode": "md" }, { "name": "--max-width", "annotation": "prop", "docs": "Maximum width of the action sheet", "mode": "ios" }, { "name": "--max-width", "annotation": "prop", "docs": "Maximum width of the action sheet", "mode": "md" }, { "name": "--min-height", "annotation": "prop", "docs": "Minimum height of the action sheet", "mode": "ios" }, { "name": "--min-height", "annotation": "prop", "docs": "Minimum height of the action sheet", "mode": "md" }, { "name": "--min-width", "annotation": "prop", "docs": "Minimum width of the action sheet", "mode": "ios" }, { "name": "--min-width", "annotation": "prop", "docs": "Minimum width of the action sheet", "mode": "md" }, { "name": "--width", "annotation": "prop", "docs": "Width of the action sheet", "mode": "ios" }, { "name": "--width", "annotation": "prop", "docs": "Width of the action sheet", "mode": "md" } ], "slots": [], "parts": [], "dependents": [ "ion-select" ], "dependencies": [ "ion-backdrop", "ion-icon", "ion-ripple-effect" ], "dependencyGraph": { "ion-action-sheet": [ "ion-backdrop", "ion-icon", "ion-ripple-effect" ], "ion-select": [ "ion-action-sheet" ] } }, { "filePath": "src/components/alert/alert.tsx", "encapsulation": "scoped", "tag": "ion-alert", "docs": "", "docsTags": [ { "name": "virtualProp", "text": "{\"ios\" | \"md\"} mode - The mode determines which platform styles to use." } ], "usage": {}, "props": [ { "name": "animated", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "animated", "reflectToAttr": false, "docs": "If `true`, the alert will animate.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "backdropDismiss", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "backdrop-dismiss", "reflectToAttr": false, "docs": "If `true`, the alert will be dismissed when the backdrop is clicked.", "docsTags": [], "default": "true", "values": [ { "type": "boolean" } ], "optional": false, "required": false }, { "name": "buttons", "type": "(string | AlertButton)[]", "complexType": { "original": "(AlertButton | string)[]", "resolved": "(string | AlertButton)[]", "references": { "AlertButton": { "location": "import", "path": "./alert-interface", "id": "src/components/alert/alert-interface.ts::AlertButton" } } }, "mutable": false, "reflectToAttr": false, "docs": "Array of buttons to be added to the alert.", "docsTags": [], "default": "[]", "values": [ { "type": "(string" }, { "type": "AlertButton)[]" } ], "optional": false, "required": false }, { "name": "cssClass", "type": "string | string[] | undefined", "complexType": { "original": "string | string[]", "resolved": "string | string[] | undefined", "references": {} }, "mutable": false, "attr": "css-class", "reflectToAttr": false, "docs": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces.", "docsTags": [], "values": [ { "type": "string" }, { "type": "string[]" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "enterAnimation", "type": "((baseEl: any, opts?: any) => Animation) | undefined", "complexType": { "original": "AnimationBuilder", "resolved": "((baseEl: any, opts?: any) => Animation) | undefined", "references": { "AnimationBuilder": { "location": "import", "path": "../../interface", "id": "src/interface.d.ts::AnimationBuilder" } } }, "mutable": false, "reflectToAttr": false, "docs": "Animation to use when the alert is presented.", "docsTags": [], "values": [ { "type": "((baseEl: any, opts?: any) => Animation)" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "header", "type": "string | undefined", "complexType": { "original": "string", "resolved": "string | undefined", "references": {} }, "mutable": false, "attr": "header", "reflectToAttr": false, "docs": "The main title in the heading of the alert.", "docsTags": [], "values": [ { "type": "string" }, { "type": "undefined" } ], "optional": true, "required": false }, { "name": "htmlAttributes", "type": "undefined | { [key: string]: any; }", "complexType": { "original": "{ [key: string]: any }", "resolved": "undefined | { [key: string]: any; }", "references": {} }, "mutable": false, "reflectToAttr": false, "docs": "Additional attributes to pass to the alert.", "docsTags": [], "values": [ { "type": "undefined" }, { "type": "{ [key: string]: any; }" } ], "optional": true, "required": false }, { "name": "inputs", "type": "AlertInput[]", "complexType": { "original": "AlertInput[]", "resolved": "AlertInput[]", "references": { "AlertInput": { "location": "import", "path": "./alert-interface", "id": "src/components/alert/alert-interface.ts::AlertInput" } } }, "mutable": true, "reflectToAttr": false, "docs": "Array of input to show in the alert.", "docsTags": [], "default": "[]", "values": [ { "type": "AlertInput[]" } ], "optional": false, "required": false }, { "name": "isOpen", "type": "boolean", "complexType": { "original": "boolean", "resolved": "boolean", "references": {} }, "mutable": false, "attr": "is-open", "reflectToAttr": false, "docs": "If `true`, the alert will open. If `false`, the alert will close.\nUse this if you need finer grained control over presentation, otherwise\njust use the alertController or the `trigger` property.\nNote: `isOpen` will not automatically be set back to `false` when\nthe alert dismisses. You will need to do that in your code.", "docsT