@ionic/core 9.0.0 → 9.0.1-dev.11787248963.10a00c73

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

@@ -34,177 +34,202 @@ import { setCardStatusBarDark, setCardStatusBarDefault } from "./utils";
  * @part handle - The handle that is displayed at the top of the sheet modal when `handle="true"`.
  */
 export class Modal {
-    lockController = createLockController();
-    triggerController = createTriggerController();
-    gesture;
-    coreDelegate = CoreDelegate();
-    sheetTransition;
-    isSheetModal = false;
-    /**
-     * The breakpoint value that has been committed for a sheet modal.
-     * This represents the modal's resting state when it is not being dragged
-     * or animating toward a new position.
-     */
-    currentBreakpoint;
-    wrapperEl;
-    backdropEl;
-    dragHandleEl;
-    sortedBreakpoints;
-    keyboardOpenCallback;
-    moveSheetToBreakpoint;
-    resetSheetContentScroll;
-    inheritedAttributes = {};
-    statusBarStyle;
-    inline = false;
-    workingDelegate;
-    // Reference to the user's provided modal content
-    usersElement;
-    // Whether or not modal is being dismissed via gesture
-    gestureAnimationDismissing = false;
-    // View transition properties for handling portrait/landscape switches
-    currentViewIsPortrait;
-    viewTransitionAnimation;
-    resizeTimeout;
-    unsubscribeRootSafeAreaTop;
-    // Mutation observer to watch for parent removal
-    parentRemovalObserver;
-    // Cached original parent from before modal is moved to body during presentation
-    cachedOriginalParent;
-    // Cached ion-page ancestor for child route passthrough
-    cachedPageParent;
-    lastFocus;
-    animation;
-    presented = false;
-    el;
-    /** @internal */
-    hasController = false;
-    /** @internal */
-    overlayIndex;
-    /** @internal */
-    delegate;
-    /**
-     * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
-     */
-    keyboardClose = true;
-    /**
-     * Animation to use when the modal is presented.
-     */
-    enterAnimation;
-    /**
-     * Animation to use when the modal is dismissed.
-     */
-    leaveAnimation;
-    /**
-     * The breakpoints to use when creating a sheet modal. Each value in the
-     * array must be a decimal between 0 and 1 where 0 indicates the modal is fully
-     * closed and 1 indicates the modal is fully open. Values are relative
-     * to the height of the modal, not the height of the screen. One of the values in this
-     * array must be the value of the `initialBreakpoint` property.
-     * For example: [0, .25, .5, 1]
-     */
-    breakpoints;
-    /**
-     * 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.
-     */
-    expandToScroll = true;
-    /**
-     * A decimal value between 0 and 1 that indicates the
-     * initial point the modal will open at when creating a
-     * sheet modal. This value must also be listed in the
-     * `breakpoints` array.
-     */
-    initialBreakpoint;
-    /**
-     * 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.
-     */
-    backdropBreakpoint = 0;
-    /**
-     * The horizontal line that displays at the top of a sheet modal. It is `true` by default when
-     * setting the `breakpoints` and `initialBreakpoint` properties.
-     */
-    handle;
-    /**
-     * The interaction behavior for the sheet modal when the handle is 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).
-     *
-     * Set to `"cycle"` to make the handle focusable and let the sheet modal
-     * cycle between available breakpoints when pressed. This keeps the sheet
-     * operable with assistive technology.
-     *
-     * Set to `"none"` to make the handle purely decorative when pressed and
-     * removed from the tab order.
-     *
-     * Defaults to `"cycle"`.
-     */
-    handleBehavior = 'cycle';
-    /**
-     * The component to display inside of the modal.
-     * @internal
-     */
-    component;
-    /**
-     * The data to pass to the modal component.
-     * @internal
-     */
-    componentProps;
-    /**
-     * Additional classes to apply for custom CSS. If multiple classes are
-     * provided they should be separated by spaces.
-     * @internal
-     */
-    cssClass;
-    /**
-     * If `true`, the modal will be dismissed when the backdrop is clicked.
-     */
-    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.
-     */
-    showBackdrop = true;
-    /**
-     * If `true`, the modal will animate.
-     */
-    animated = true;
-    /**
-     * The element that presented the modal. This is used for card presentation effects
-     * and for stacking multiple modals on top of each other. Only applies in iOS mode.
-     */
-    presentingElement;
-    /**
-     * Additional attributes to pass to the modal.
-     */
-    htmlAttributes;
-    /**
-     * 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.
-     */
-    isOpen = false;
+    constructor() {
+        this.lockController = createLockController();
+        this.triggerController = createTriggerController();
+        this.coreDelegate = CoreDelegate();
+        this.isSheetModal = false;
+        this.inheritedAttributes = {};
+        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.
+         *
+         * 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).
+         *
+         * Set to `"cycle"` to make the handle focusable and let the sheet modal
+         * cycle between available breakpoints when pressed. This keeps the sheet
+         * operable with assistive technology.
+         *
+         * Set to `"none"` to make the handle purely decorative when pressed and
+         * removed from the tab order.
+         *
+         * Defaults to `"cycle"`.
+         */
+        this.handleBehavior = 'cycle';
+        /**
+         * 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) {
+                /**
+                 * The sheet modal should not advance to the next breakpoint
+                 * if the handle behavior is not `cycle` or if the handle
+                 * is clicked while the sheet is moving to a breakpoint.
+                 */
+                return;
+            }
+            this.moveToNextBreakpoint();
+        };
+        this.onBackdropTap = () => {
+            const { sheetTransition } = this;
+            if (sheetTransition !== undefined) {
+                /**
+                 * When the handle is double clicked at the largest breakpoint,
+                 * it will start to move to the first breakpoint. While transitioning,
+                 * the backdrop will often receive the second click. We prevent the
+                 * backdrop from dismissing the modal while moving between breakpoints.
+                 */
+                return;
+            }
+            this.dismiss(undefined, BACKDROP);
+        };
+        this.onLifecycle = (modalEvent) => {
+            const el = this.usersElement;
+            const name = LIFECYCLE_MAP[modalEvent.type];
+            if (el && name) {
+                const ev = new CustomEvent(name, {
+                    bubbles: false,
+                    cancelable: false,
+                    detail: modalEvent.detail,
+                });
+                el.dispatchEvent(ev);
+            }
+        };
+        /**
+         * When the modal receives focus directly, pass focus to the handle
+         * if it exists and is focusable, otherwise let the focus trap handle it.
+         */
+        this.onModalFocus = (ev) => {
+            const { dragHandleEl, el } = this;
+            /**
+             * Shadow DOM focus is retargeted to the host, so `ev.target === el` is also
+             * true when a shadow child (the dialog wrapper present() focuses) is focused.
+             * shadowRoot's activeElement is null only when the host was focused directly,
+             * so redirect to the handle only then and leave present()'s wrapper focus intact.
+             */
+            if (ev.target === el && el.shadowRoot?.activeElement == null && dragHandleEl && dragHandleEl.tabIndex !== -1) {
+                dragHandleEl.focus();
+            }
+        };
+        /**
+         * When the slot changes, we need to find all the modals in the slot
+         * and set the data-parent-ion-modal attribute on them so we can find them
+         * and dismiss them when we get dismissed.
+         * We need to do it this way because when a modal is opened, it's moved to
+         * the end of the body and is no longer an actual child of the modal.
+         */
+        this.onSlotChange = ({ target }) => {
+            const slot = target;
+            slot.assignedElements().forEach((el) => {
+                el.querySelectorAll('ion-modal').forEach((childModal) => {
+                    // We don't need to write to the DOM if the modal is already tagged
+                    // If this is a deeply nested modal, this effect should cascade so we don't
+                    // need to worry about another modal claiming the same child.
+                    if (childModal.getAttribute('data-parent-ion-modal') === null) {
+                        childModal.setAttribute('data-parent-ion-modal', this.el.id);
+                    }
+                });
+            });
+        };
+    }
     onIsOpenChange(newValue, oldValue) {
         if (newValue === true && oldValue === false) {
             this.present();
@@ -213,11 +238,6 @@ export class Modal {
             this.dismiss();
         }
     }
-    /**
-     * An ID corresponding to the trigger element that
-     * causes the modal to open when clicked.
-     */
-    trigger;
     triggerChanged() {
         const { trigger, el, triggerController } = this;
         if (trigger) {
@@ -250,108 +270,6 @@ export class Modal {
             }
         }, 50); // Debounce to avoid excessive calls during active resizing
     }
-    /**
-     * 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.
-     */
-    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.
-     */
-    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.
-     */
-    canDismiss = true;
-    /**
-     * Emitted after the modal has presented.
-     */
-    didPresent;
-    /**
-     * Emitted before the modal has presented.
-     */
-    willPresent;
-    /**
-     * Emitted before the modal has dismissed.
-     */
-    willDismiss;
-    /**
-     * Emitted after the modal has dismissed.
-     */
-    didDismiss;
-    /**
-     * Emitted after the modal breakpoint has changed.
-     */
-    ionBreakpointDidChange;
-    /**
-     * Emitted after the modal has presented.
-     * Shorthand for ionModalDidPresent.
-     */
-    didPresentShorthand;
-    /**
-     * Emitted before the modal has presented.
-     * Shorthand for ionModalWillPresent.
-     */
-    willPresentShorthand;
-    /**
-     * Emitted before the modal has dismissed.
-     * Shorthand for ionModalWillDismiss.
-     */
-    willDismissShorthand;
-    /**
-     * Emitted after the modal has dismissed.
-     * Shorthand for ionModalDidDismiss.
-     */
-    didDismissShorthand;
-    /**
-     * Emitted before the modal has presented, but after the component
-     * has been mounted in the DOM.
-     * This event exists so iOS can run the entering
-     * transition properly
-     *
-     * @internal
-     */
-    ionMount;
-    /**
-     * Event that is emitted when the sheet modal or card modal gesture starts.
-     */
-    ionDragStart;
-    /**
-     * Event that is emitted when the sheet modal or card modal gesture moves.
-     */
-    ionDragMove;
-    /**
-     * Event that is emitted when the sheet modal or card modal gesture ends.
-     */
-    ionDragEnd;
     breakpointsChanged(breakpoints) {
         if (breakpoints !== undefined) {
             this.sortedBreakpoints = breakpoints.sort((a, b) => a - b);
@@ -919,59 +837,6 @@ export class Modal {
         await this.setCurrentBreakpoint(nextBreakpoint);
         return true;
     }
-    onHandleClick = () => {
-        const { sheetTransition, handleBehavior } = this;
-        if (handleBehavior !== 'cycle' || sheetTransition !== undefined) {
-            /**
-             * The sheet modal should not advance to the next breakpoint
-             * if the handle behavior is not `cycle` or if the handle
-             * is clicked while the sheet is moving to a breakpoint.
-             */
-            return;
-        }
-        this.moveToNextBreakpoint();
-    };
-    onBackdropTap = () => {
-        const { sheetTransition } = this;
-        if (sheetTransition !== undefined) {
-            /**
-             * When the handle is double clicked at the largest breakpoint,
-             * it will start to move to the first breakpoint. While transitioning,
-             * the backdrop will often receive the second click. We prevent the
-             * backdrop from dismissing the modal while moving between breakpoints.
-             */
-            return;
-        }
-        this.dismiss(undefined, BACKDROP);
-    };
-    onLifecycle = (modalEvent) => {
-        const el = this.usersElement;
-        const name = LIFECYCLE_MAP[modalEvent.type];
-        if (el && name) {
-            const ev = new CustomEvent(name, {
-                bubbles: false,
-                cancelable: false,
-                detail: modalEvent.detail,
-            });
-            el.dispatchEvent(ev);
-        }
-    };
-    /**
-     * When the modal receives focus directly, pass focus to the handle
-     * if it exists and is focusable, otherwise let the focus trap handle it.
-     */
-    onModalFocus = (ev) => {
-        const { dragHandleEl, el } = this;
-        /**
-         * Shadow DOM focus is retargeted to the host, so `ev.target === el` is also
-         * true when a shadow child (the dialog wrapper present() focuses) is focused.
-         * shadowRoot's activeElement is null only when the host was focused directly,
-         * so redirect to the handle only then and leave present()'s wrapper focus intact.
-         */
-        if (ev.target === el && el.shadowRoot?.activeElement == null && dragHandleEl && dragHandleEl.tabIndex !== -1) {
-            dragHandleEl.focus();
-        }
-    };
     initViewTransitionListener() {
         // Only enable for iOS card modals when no custom animations are provided
         if (getIonMode(this) !== 'ios' || !this.presentingElement || this.enterAnimation || this.leaveAnimation) {
@@ -1089,26 +954,6 @@ export class Modal {
             }
         }
     }
-    /**
-     * When the slot changes, we need to find all the modals in the slot
-     * and set the data-parent-ion-modal attribute on them so we can find them
-     * and dismiss them when we get dismissed.
-     * We need to do it this way because when a modal is opened, it's moved to
-     * the end of the body and is no longer an actual child of the modal.
-     */
-    onSlotChange = ({ target }) => {
-        const slot = target;
-        slot.assignedElements().forEach((el) => {
-            el.querySelectorAll('ion-modal').forEach((childModal) => {
-                // We don't need to write to the DOM if the modal is already tagged
-                // If this is a deeply nested modal, this effect should cascade so we don't
-                // need to worry about another modal claiming the same child.
-                if (childModal.getAttribute('data-parent-ion-modal') === null) {
-                    childModal.setAttribute('data-parent-ion-modal', this.el.id);
-                }
-            });
-        });
-    };
     async dismissNestedModals() {
         const nestedModals = document.querySelectorAll(`ion-modal[data-parent-ion-modal="${this.el.id}"]`);
         nestedModals?.forEach(async (modal) => {

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

@@ -3,9 +3,6 @@
  */
 import { dragElementBy } from "../../../utils/test/playwright/index";
 export class CardModalPage {
-    ionModalDidPresent;
-    ionModalDidDismiss;
-    page;
     constructor(page) {
         this.page = page;
     }