voyager-ionic-core 8.5.7 → 8.6.1

package/dist/collection/components/modal/modal.js

@@ -41,6 +41,112 @@ export class Modal {
         this.inline = false;
         // Whether or not modal is being dismissed via gesture
         this.gestureAnimationDismissing = false;
+        this.presented = false;
+        /** @internal */
+        this.hasController = false;
+        /**
+         * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
+         */
+        this.keyboardClose = true;
+        /**
+         * Controls whether scrolling or dragging within the sheet modal expands
+         * it to a larger breakpoint. This only takes effect when `breakpoints`
+         * and `initialBreakpoint` are set.
+         *
+         * If `true`, scrolling or dragging anywhere in the modal will first expand
+         * it to the next breakpoint. Once fully expanded, scrolling will affect the
+         * content.
+         * If `false`, scrolling will always affect the content. The modal will
+         * only expand when dragging the header or handle. The modal will close when
+         * dragging the header or handle. It can also be closed when dragging the
+         * content, but only if the content is scrolled to the top.
+         */
+        this.expandToScroll = true;
+        /**
+         * A decimal value between 0 and 1 that indicates the
+         * point after which the backdrop will begin to fade in
+         * when using a sheet modal. Prior to this point, the
+         * backdrop will be hidden and the content underneath
+         * the sheet can be interacted with. This value is exclusive
+         * meaning the backdrop will become active after the value
+         * specified.
+         */
+        this.backdropBreakpoint = 0;
+        /**
+         * The interaction behavior for the sheet modal when the handle is pressed.
+         *
+         * Defaults to `"none"`, which  means the modal will not change size or position when the handle is pressed.
+         * Set to `"cycle"` to let the modal cycle between available breakpoints when pressed.
+         *
+         * Handle behavior is unavailable when the `handle` property is set to `false` or
+         * when the `breakpoints` property is not set (using a fullscreen or card modal).
+         */
+        this.handleBehavior = 'none';
+        /**
+         * If `true`, the modal will be dismissed when the backdrop is clicked.
+         */
+        this.backdropDismiss = true;
+        /**
+         * If `true`, a backdrop will be displayed behind the modal.
+         * This property controls whether or not the backdrop
+         * darkens the screen when the modal is presented.
+         * It does not control whether or not the backdrop
+         * is active or present in the DOM.
+         */
+        this.showBackdrop = true;
+        /**
+         * If `true`, the modal will animate.
+         */
+        this.animated = true;
+        /**
+         * If `true`, the modal will open. If `false`, the modal will close.
+         * Use this if you need finer grained control over presentation, otherwise
+         * just use the modalController or the `trigger` property.
+         * Note: `isOpen` will not automatically be set back to `false` when
+         * the modal dismisses. You will need to do that in your code.
+         */
+        this.isOpen = false;
+        /**
+         * If `true`, the component passed into `ion-modal` will
+         * automatically be mounted when the modal is created. The
+         * component will remain mounted even when the modal is dismissed.
+         * However, the component will be destroyed when the modal is
+         * destroyed. This property is not reactive and should only be
+         * used when initially creating a modal.
+         *
+         * Note: This feature only applies to inline modals in JavaScript
+         * frameworks such as Angular, React, and Vue.
+         */
+        this.keepContentsMounted = false;
+        /**
+         * If `true`, focus will not be allowed to move outside of this overlay.
+         * If `false`, focus will be allowed to move outside of the overlay.
+         *
+         * In most scenarios this property should remain set to `true`. Setting
+         * this property to `false` can cause severe accessibility issues as users
+         * relying on assistive technologies may be able to move focus into
+         * a confusing state. We recommend only setting this to `false` when
+         * absolutely necessary.
+         *
+         * Developers may want to consider disabling focus trapping if this
+         * overlay presents a non-Ionic overlay from a 3rd party library.
+         * Developers would disable focus trapping on the Ionic overlay
+         * when presenting the 3rd party overlay and then re-enable
+         * focus trapping when dismissing the 3rd party overlay and moving
+         * focus back to the Ionic overlay.
+         */
+        this.focusTrap = true;
+        /**
+         * Determines whether or not a modal can dismiss
+         * when calling the `dismiss` method.
+         *
+         * If the value is `true` or the value's function returns `true`, the modal will close when trying to dismiss.
+         * If the value is `false` or the value's function returns `false`, the modal will not close when trying to dismiss.
+         *
+         * See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this
+         * if you need to access `this` from within the callback.
+         */
+        this.canDismiss = true;
         this.onHandleClick = () => {
             const { sheetTransition, handleBehavior } = this;
             if (handleBehavior !== 'cycle' || sheetTransition !== undefined) {
@@ -78,32 +184,6 @@ export class Modal {
                 el.dispatchEvent(ev);
             }
         };
-        this.presented = false;
-        this.hasController = false;
-        this.overlayIndex = undefined;
-        this.delegate = undefined;
-        this.keyboardClose = true;
-        this.enterAnimation = undefined;
-        this.leaveAnimation = undefined;
-        this.breakpoints = undefined;
-        this.expandToScroll = true;
-        this.initialBreakpoint = undefined;
-        this.backdropBreakpoint = 0;
-        this.handle = undefined;
-        this.handleBehavior = 'none';
-        this.component = undefined;
-        this.componentProps = undefined;
-        this.cssClass = undefined;
-        this.backdropDismiss = true;
-        this.showBackdrop = true;
-        this.animated = true;
-        this.presentingElement = undefined;
-        this.htmlAttributes = undefined;
-        this.isOpen = false;
-        this.trigger = undefined;
-        this.keepContentsMounted = false;
-        this.focusTrap = true;
-        this.canDismiss = true;
     }
     onIsOpenChange(newValue, oldValue) {
         if (newValue === true && oldValue === false) {
@@ -573,18 +653,18 @@ export class Modal {
         const mode = getIonMode(this);
         const isCardModal = presentingElement !== undefined && mode === 'ios';
         const isHandleCycle = handleBehavior === 'cycle';
-        return (h(Host, Object.assign({ key: '0991b2e4e32da511e59fb1463b47e4ac1b86d1ca', "no-router": true, tabindex: "-1" }, htmlAttributes, { style: {
+        return (h(Host, Object.assign({ key: '0bcbdcfcd7d890eb599da3f97f21c317d34f8e0e', "no-router": true, tabindex: "-1" }, htmlAttributes, { style: {
                 zIndex: `${20000 + this.overlayIndex}`,
-            }, class: Object.assign({ [mode]: true, ['modal-default']: !isCardModal && !isSheetModal, [`modal-card`]: isCardModal, [`modal-sheet`]: isSheetModal, [`modal-no-expand-scroll`]: isSheetModal && !expandToScroll, 'overlay-hidden': true, [FOCUS_TRAP_DISABLE_CLASS]: focusTrap === false }, getClassMap(this.cssClass)), onIonBackdropTap: this.onBackdropTap, onIonModalDidPresent: this.onLifecycle, onIonModalWillPresent: this.onLifecycle, onIonModalWillDismiss: this.onLifecycle, onIonModalDidDismiss: this.onLifecycle }), h("ion-backdrop", { key: 'ca9453ffe1021fb252ad9460676cfabb5633f00f', ref: (el) => (this.backdropEl = el), visible: this.showBackdrop, tappable: this.backdropDismiss, part: "backdrop" }), mode === 'ios' && h("div", { key: '9f8da446a7b0f3b26aec856e13f6d6d131a7e37b', class: "modal-shadow" }), h("div", Object.assign({ key: '9d08bf600571849c97b58f66df40b496a358d1e1',
+            }, class: Object.assign({ [mode]: true, ['modal-default']: !isCardModal && !isSheetModal, [`modal-card`]: isCardModal, [`modal-sheet`]: isSheetModal, [`modal-no-expand-scroll`]: isSheetModal && !expandToScroll, 'overlay-hidden': true, [FOCUS_TRAP_DISABLE_CLASS]: focusTrap === false }, getClassMap(this.cssClass)), onIonBackdropTap: this.onBackdropTap, onIonModalDidPresent: this.onLifecycle, onIonModalWillPresent: this.onLifecycle, onIonModalWillDismiss: this.onLifecycle, onIonModalDidDismiss: this.onLifecycle }), h("ion-backdrop", { key: 'd72159e73daa5af7349aa9e8f695aa435eb43069', ref: (el) => (this.backdropEl = el), visible: this.showBackdrop, tappable: this.backdropDismiss, part: "backdrop" }), mode === 'ios' && h("div", { key: 'fd2d9b13676ae72473881649a397b6eacde03a03', class: "modal-shadow" }), h("div", Object.assign({ key: '908eccb1ad982dcde2dbcff0cbb18b6e60f8ba74',
             /*
               role and aria-modal must be used on the
               same element. They must also be set inside the
               shadow DOM otherwise ion-button will not be highlighted
               when using VoiceOver: https://bugs.webkit.org/show_bug.cgi?id=247134
             */
-            role: "dialog" }, inheritedAttributes, { "aria-modal": "true", class: "modal-wrapper ion-overlay-wrapper", part: "content", ref: (el) => (this.wrapperEl = el) }), showHandle && (h("button", { key: 'f8bf0d1126e5376519101225d9965727121ee042', class: "modal-handle",
+            role: "dialog" }, inheritedAttributes, { "aria-modal": "true", class: "modal-wrapper ion-overlay-wrapper", part: "content", ref: (el) => (this.wrapperEl = el) }), showHandle && (h("button", { key: '332dc0b40363a77c7be62331d9f26def91c790e9', class: "modal-handle",
             // Prevents the handle from receiving keyboard focus when it does not cycle
-            tabIndex: !isHandleCycle ? -1 : 0, "aria-label": "Activate to adjust the size of the dialog overlaying the screen", onClick: isHandleCycle ? this.onHandleClick : undefined, part: "handle" })), h("slot", { key: '6d52849df98f2c6c8fbc03996a931ea6a39a512b' }))));
+            tabIndex: !isHandleCycle ? -1 : 0, "aria-label": "Activate to adjust the size of the dialog overlaying the screen", onClick: isHandleCycle ? this.onHandleClick : undefined, part: "handle" })), h("slot", { key: 'c32698350193c450327e97049daf8b8d1fda0d0e' }))));
     }
     static get is() { return "ion-modal"; }
     static get encapsulation() { return "shadow"; }
@@ -604,6 +684,7 @@ export class Modal {
         return {
             "hasController": {
                 "type": "boolean",
+                "attribute": "has-controller",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -619,12 +700,14 @@ export class Modal {
                         }],
                     "text": ""
                 },
-                "attribute": "has-controller",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "overlayIndex": {
                 "type": "number",
+                "attribute": "overlay-index",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -640,11 +723,13 @@ export class Modal {
                         }],
                     "text": ""
                 },
-                "attribute": "overlay-index",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "delegate": {
                 "type": "unknown",
+                "attribute": "delegate",
                 "mutable": false,
                 "complexType": {
                     "original": "FrameworkDelegate",
@@ -665,10 +750,13 @@ export class Modal {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "keyboardClose": {
                 "type": "boolean",
+                "attribute": "keyboard-close",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -681,12 +769,14 @@ export class Modal {
                     "tags": [],
                     "text": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
                 },
-                "attribute": "keyboard-close",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "enterAnimation": {
                 "type": "unknown",
+                "attribute": "enter-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -704,10 +794,13 @@ export class Modal {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the modal is presented."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "leaveAnimation": {
                 "type": "unknown",
+                "attribute": "leave-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -725,10 +818,13 @@ export class Modal {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the modal is dismissed."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "breakpoints": {
                 "type": "unknown",
+                "attribute": "breakpoints",
                 "mutable": false,
                 "complexType": {
                     "original": "number[]",
@@ -740,10 +836,13 @@ export class Modal {
                 "docs": {
                     "tags": [],
                     "text": "The breakpoints to use when creating a sheet modal. Each value in the\narray must be a decimal between 0 and 1 where 0 indicates the modal is fully\nclosed and 1 indicates the modal is fully open. Values are relative\nto the height of the modal, not the height of the screen. One of the values in this\narray must be the value of the `initialBreakpoint` property.\nFor example: [0, .25, .5, 1]"
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "expandToScroll": {
                 "type": "boolean",
+                "attribute": "expand-to-scroll",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -756,12 +855,14 @@ export class Modal {
                     "tags": [],
                     "text": "Controls whether scrolling or dragging within the sheet modal expands\nit to a larger breakpoint. This only takes effect when `breakpoints`\nand `initialBreakpoint` are set.\n\nIf `true`, scrolling or dragging anywhere in the modal will first expand\nit to the next breakpoint. Once fully expanded, scrolling will affect the\ncontent.\nIf `false`, scrolling will always affect the content. The modal will\nonly expand when dragging the header or handle. The modal will close when\ndragging the header or handle. It can also be closed when dragging the\ncontent, but only if the content is scrolled to the top."
                 },
-                "attribute": "expand-to-scroll",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "initialBreakpoint": {
                 "type": "number",
+                "attribute": "initial-breakpoint",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -774,11 +875,13 @@ export class Modal {
                     "tags": [],
                     "text": "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."
                 },
-                "attribute": "initial-breakpoint",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "backdropBreakpoint": {
                 "type": "number",
+                "attribute": "backdrop-breakpoint",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -791,12 +894,14 @@ export class Modal {
                     "tags": [],
                     "text": "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."
                 },
-                "attribute": "backdrop-breakpoint",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "0"
             },
             "handle": {
                 "type": "boolean",
+                "attribute": "handle",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -809,11 +914,13 @@ export class Modal {
                     "tags": [],
                     "text": "The horizontal line that displays at the top of a sheet modal. It is `true` by default when\nsetting the `breakpoints` and `initialBreakpoint` properties."
                 },
-                "attribute": "handle",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "handleBehavior": {
                 "type": "string",
+                "attribute": "handle-behavior",
                 "mutable": false,
                 "complexType": {
                     "original": "ModalHandleBehavior",
@@ -832,12 +939,14 @@ export class Modal {
                     "tags": [],
                     "text": "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)."
                 },
-                "attribute": "handle-behavior",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'none'"
             },
             "component": {
                 "type": "string",
+                "attribute": "component",
                 "mutable": false,
                 "complexType": {
                     "original": "ComponentRef",
@@ -859,11 +968,13 @@ export class Modal {
                         }],
                     "text": "The component to display inside of the modal."
                 },
-                "attribute": "component",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "componentProps": {
                 "type": "unknown",
+                "attribute": "component-props",
                 "mutable": false,
                 "complexType": {
                     "original": "ComponentProps",
@@ -884,10 +995,13 @@ export class Modal {
                             "text": undefined
                         }],
                     "text": "The data to pass to the modal component."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "cssClass": {
                 "type": "string",
+                "attribute": "css-class",
                 "mutable": false,
                 "complexType": {
                     "original": "string | string[]",
@@ -903,11 +1017,13 @@ export class Modal {
                         }],
                     "text": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
                 },
-                "attribute": "css-class",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "backdropDismiss": {
                 "type": "boolean",
+                "attribute": "backdrop-dismiss",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -920,12 +1036,14 @@ export class Modal {
                     "tags": [],
                     "text": "If `true`, the modal will be dismissed when the backdrop is clicked."
                 },
-                "attribute": "backdrop-dismiss",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "showBackdrop": {
                 "type": "boolean",
+                "attribute": "show-backdrop",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -938,12 +1056,14 @@ export class Modal {
                     "tags": [],
                     "text": "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."
                 },
-                "attribute": "show-backdrop",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "animated": {
                 "type": "boolean",
+                "attribute": "animated",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -956,12 +1076,14 @@ export class Modal {
                     "tags": [],
                     "text": "If `true`, the modal will animate."
                 },
-                "attribute": "animated",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "presentingElement": {
                 "type": "unknown",
+                "attribute": "presenting-element",
                 "mutable": false,
                 "complexType": {
                     "original": "HTMLElement",
@@ -978,10 +1100,13 @@ export class Modal {
                 "docs": {
                     "tags": [],
                     "text": "The element that presented the modal. This is used for card presentation effects\nand for stacking multiple modals on top of each other. Only applies in iOS mode."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "htmlAttributes": {
                 "type": "unknown",
+                "attribute": "html-attributes",
                 "mutable": false,
                 "complexType": {
                     "original": "{ [key: string]: any }",
@@ -993,10 +1118,13 @@ export class Modal {
                 "docs": {
                     "tags": [],
                     "text": "Additional attributes to pass to the modal."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "isOpen": {
                 "type": "boolean",
+                "attribute": "is-open",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1009,12 +1137,14 @@ export class Modal {
                     "tags": [],
                     "text": "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."
                 },
-                "attribute": "is-open",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "trigger": {
                 "type": "string",
+                "attribute": "trigger",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -1027,11 +1157,13 @@ export class Modal {
                     "tags": [],
                     "text": "An ID corresponding to the trigger element that\ncauses the modal to open when clicked."
                 },
-                "attribute": "trigger",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "keepContentsMounted": {
                 "type": "boolean",
+                "attribute": "keep-contents-mounted",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1044,12 +1176,14 @@ export class Modal {
                     "tags": [],
                     "text": "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."
                 },
-                "attribute": "keep-contents-mounted",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "focusTrap": {
                 "type": "boolean",
+                "attribute": "focus-trap",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -1062,12 +1196,14 @@ export class Modal {
                     "tags": [],
                     "text": "If `true`, focus will not be allowed to move outside of this overlay.\nIf `false`, focus will be allowed to move outside of the overlay.\n\nIn most scenarios this property should remain set to `true`. Setting\nthis property to `false` can cause severe accessibility issues as users\nrelying on assistive technologies may be able to move focus into\na confusing state. We recommend only setting this to `false` when\nabsolutely necessary.\n\nDevelopers may want to consider disabling focus trapping if this\noverlay presents a non-Ionic overlay from a 3rd party library.\nDevelopers would disable focus trapping on the Ionic overlay\nwhen presenting the 3rd party overlay and then re-enable\nfocus trapping when dismissing the 3rd party overlay and moving\nfocus back to the Ionic overlay."
                 },
-                "attribute": "focus-trap",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "canDismiss": {
                 "type": "boolean",
+                "attribute": "can-dismiss",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | ((data?: any, role?: string) => Promise<boolean>)",
@@ -1085,7 +1221,8 @@ export class Modal {
                     "tags": [],
                     "text": "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.\n\nSee https://ionicframework.com/docs/troubleshooting/runtime#accessing-this\nif you need to access `this` from within the callback."
                 },
-                "attribute": "can-dismiss",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             }