@ionic/core 8.7.17-dev.11771865171.14f4c2cf → 8.7.17-dev.11771870864.19b2cde1

package/components/modal.js

@@ -246,7 +246,7 @@ const calculateSpringStep = (t) => {
 const SwipeToCloseDefaults = {
     MIN_PRESENTING_SCALE: 0.915,
 };
-const createSwipeToCloseGesture = (el, animation, statusBarStyle, onDismiss) => {
+const createSwipeToCloseGesture = (el, animation, statusBarStyle, onDismiss, onDragStart, onDragMove, onDragEnd) => {
     /**
      * The step value at which a card modal
      * is eligible for dismissing via gesture.
@@ -356,6 +356,7 @@ const createSwipeToCloseGesture = (el, animation, statusBarStyle, onDismiss) =>
             disableContentScrollY(contentEl);
         }
         animation.progressStart(true, isOpen ? 1 : 0);
+        onDragStart();
     };
     const onMove = (detail) => {
         const { deltaY } = detail;
@@ -423,6 +424,13 @@ const createSwipeToCloseGesture = (el, animation, statusBarStyle, onDismiss) =>
             setCardStatusBarDark();
         }
         lastStep = clampedStep;
+        const eventDetail = {
+            currentY: detail.currentY,
+            deltaY: detail.deltaY,
+            velocityY: detail.velocityY,
+            progress: calculateProgress(el, detail.deltaY),
+        };
+        onDragMove(eventDetail);
     };
     const onEnd = (detail) => {
         const velocity = detail.velocityY;
@@ -481,6 +489,13 @@ const createSwipeToCloseGesture = (el, animation, statusBarStyle, onDismiss) =>
         else if (shouldComplete) {
             onDismiss();
         }
+        const eventDetail = {
+            currentY: detail.currentY,
+            deltaY: detail.deltaY,
+            velocityY: detail.velocityY,
+            progress: calculateProgress(el, detail.deltaY),
+        };
+        onDragEnd(eventDetail);
     };
     const gesture = createGesture({
         el,
@@ -498,6 +513,44 @@ const createSwipeToCloseGesture = (el, animation, statusBarStyle, onDismiss) =>
 const computeDuration = (remaining, velocity) => {
     return clamp(400, remaining / Math.abs(velocity * 1.1), 500);
 };
+/**
+ * Calculates the progress of the swipe gesture.
+ *
+ * The progress is a value between 0 and 1 that represents how far
+ * the swipe has progressed towards closing the modal.
+ *
+ * A value closer to 1 means the modal is closer to being opened,
+ * while a value closer to 0 means the modal is closer to being closed.
+ *
+ * @param el The modal
+ * @param deltaY The change in Y position (positive when dragging down, negative when dragging up)
+ * @returns The progress of the swipe gesture
+ */
+const calculateProgress = (el, deltaY) => {
+    const windowHeight = window.innerHeight;
+    // Position when fully open
+    const modalTop = el.getBoundingClientRect().top;
+    /**
+     * The distance between the top of the modal and the bottom of the screen
+     * is the total distance the modal needs to travel to be fully closed.
+     */
+    const totalDistance = windowHeight - modalTop;
+    /**
+     * The pull percentage is how far the user has swiped compared to the total
+     * distance needed to close the modal.
+     */
+    const pullPercentage = deltaY / totalDistance;
+    /**
+     * The progress is the inverse of the pull percentage because
+     * when the user starts swiping up, the progress should be close to 1,
+     * and when the user has swiped all the way down, the progress should be
+     * close to 0.
+     */
+    const progress = 1 - pullPercentage;
+    // Round to the nearest thousandth to avoid returning very small decimal
+    const roundedProgress = Math.round(progress * 1000) / 1000;
+    return Math.max(0, Math.min(1, roundedProgress));
+};
 
 const createSheetEnterAnimation = (opts) => {
     const { currentBreakpoint, backdropBreakpoint, expandToScroll } = opts;
@@ -946,7 +999,7 @@ const mdLeaveAnimation = (baseEl, opts) => {
     return baseAnimation;
 };
 
-const createSheetGesture = (baseEl, backdropEl, wrapperEl, initialBreakpoint, backdropBreakpoint, animation, breakpoints = [], expandToScroll, getCurrentBreakpoint, onDismiss, onBreakpointChange) => {
+const createSheetGesture = (baseEl, backdropEl, wrapperEl, initialBreakpoint, backdropBreakpoint, animation, breakpoints = [], expandToScroll, getCurrentBreakpoint, onDismiss, onBreakpointChange, onDragStart, onDragMove, onDragEnd) => {
     // Defaults for the sheet swipe animation
     const defaultBackdrop = [
         { offset: 0, opacity: 'var(--backdrop-opacity)' },
@@ -1209,6 +1262,7 @@ const createSheetGesture = (baseEl, backdropEl, wrapperEl, initialBreakpoint, ba
             baseEl.focus();
         });
         animation.progressStart(true, 1 - currentBreakpoint);
+        onDragStart();
     };
     const onMove = (detail) => {
         /**
@@ -1277,6 +1331,15 @@ const createSheetGesture = (baseEl, backdropEl, wrapperEl, initialBreakpoint, ba
             : step;
         offset = clamp(0.0001, processedStep, maxStep);
         animation.progressStep(offset);
+        const closest = calculateClosestBreakpoint(detail.velocityY, detail.deltaY);
+        const eventDetail = {
+            currentY: detail.currentY,
+            deltaY: detail.deltaY,
+            velocityY: detail.velocityY,
+            progress: calculateProgress(detail.currentY),
+            currentBreakpoint: closest,
+        };
+        onDragMove(eventDetail);
     };
     const onEnd = (detail) => {
         /**
@@ -1295,16 +1358,7 @@ const createSheetGesture = (baseEl, backdropEl, wrapperEl, initialBreakpoint, ba
             swapFooterPosition('stationary');
             return;
         }
-        /**
-         * When the gesture releases, we need to determine
-         * the closest breakpoint to snap to.
-         */
-        const velocity = detail.velocityY;
-        const threshold = (detail.deltaY + velocity * 350) / height;
-        const diff = currentBreakpoint - threshold;
-        const closest = breakpoints.reduce((a, b) => {
-            return Math.abs(b - diff) < Math.abs(a - diff) ? b : a;
-        });
+        const closest = calculateClosestBreakpoint(detail.velocityY, detail.deltaY);
         moveSheetToBreakpoint({
             breakpoint: closest,
             breakpointOffset: offset,
@@ -1315,6 +1369,14 @@ const createSheetGesture = (baseEl, backdropEl, wrapperEl, initialBreakpoint, ba
              */
             animated: true,
         });
+        const eventDetail = {
+            currentY: detail.currentY,
+            deltaY: detail.deltaY,
+            velocityY: detail.velocityY,
+            progress: calculateProgress(detail.currentY),
+            currentBreakpoint: closest,
+        };
+        onDragEnd(eventDetail);
     };
     const moveSheetToBreakpoint = (options) => {
         const { breakpoint, canDismiss, breakpointOffset, animated } = options;
@@ -1454,6 +1516,94 @@ const createSheetGesture = (baseEl, backdropEl, wrapperEl, initialBreakpoint, ba
                 .progressEnd(1, 0, animated ? 500 : 0);
         });
     };
+    /**
+     * Calculates the closest breakpoint based on the current velocity and deltaY.
+     * This determines where the sheet should snap to when the user releases the
+     * gesture.
+     *
+     * @param velocityY The current velocity of the gesture in the Y direction.
+     * @param deltaY The change in Y position since the gesture started.
+     * @returns The closest breakpoint value.
+     */
+    const calculateClosestBreakpoint = (velocityY, deltaY) => {
+        const threshold = (deltaY + velocityY * 350) / height;
+        const diff = currentBreakpoint - threshold;
+        const closest = breakpoints.reduce((a, b) => {
+            return Math.abs(b - diff) < Math.abs(a - diff) ? b : a;
+        });
+        return closest;
+    };
+    /**
+     * Calculates the progress of the swipe gesture.
+     *
+     * The progress is a value between 0 and 1 that represents how far
+     * the swipe has progressed towards closing the modal.
+     *
+     * A value closer to 1 means the modal is closer to being opened,
+     * while a value closer to 0 means the modal is closer to being closed.
+     *
+     * @param currentY The current Y position of the gesture
+     * @returns The progress of the sheet gesture
+     */
+    const calculateProgress = (currentY) => {
+        const minBreakpoint = breakpoints[0];
+        const maxBreakpoint = breakpoints[breakpoints.length - 1];
+        // Convert breakpoints to pixel Y coordinates
+        /**
+         * The lowest point the sheet can be dragged to aka the point at which
+         * the sheet is fully closed.
+         */
+        const maxY = convertBreakpointToY(minBreakpoint);
+        /**
+         * The highest point the sheet can be dragged to aka the point at which
+         * the sheet is fully open.
+         */
+        const minY = convertBreakpointToY(maxBreakpoint);
+        // The total distance between the fully open and fully closed positions.
+        const totalDistance = maxY - minY;
+        // The distance from the current position to the fully closed position.
+        const distanceFromBottom = maxY - currentY;
+        /**
+         * The progress represents how far the sheet is from the bottom relative
+         * to the total distance. When the user starts swiping up, the progress
+         * should be close to 1, and when the user has swiped all the way down,
+         * the progress should be close to 0.
+         */
+        const progress = distanceFromBottom / totalDistance;
+        // Round to the nearest thousandth to avoid returning very small decimal
+        const roundedProgress = Math.round(progress * 1000) / 1000;
+        return Math.max(0, Math.min(1, roundedProgress));
+    };
+    /**
+     * Converts a breakpoint value (0 to 1) into a pixel Y coordinate
+     * on the screen.
+     *
+     * @param breakpoint The breakpoint value (e.g., 0.5 for half-open)
+     * @returns The pixel Y coordinate on the screen
+     */
+    const convertBreakpointToY = (breakpoint) => {
+        const rect = baseEl.getBoundingClientRect();
+        const modalHeight = rect.height;
+        // The bottom of the screen.
+        const viewportBottom = window.innerHeight;
+        /**
+         * The active height is how much of the modal is actually showing
+         * on the screen for this specific breakpoint.
+         */
+        const activeHeight = modalHeight * breakpoint;
+        /**
+         * To find the Y coordinate, start at the bottom of the screen
+         * and move up by the active height of the modal.
+         *
+         * A breakpoint of 1.0 means the active height is the full modal height
+         * (fully open). A breakpoint of 0.0 means the active height is 0
+         * (fully closed).
+         *
+         * Since screen Y coordinates get smaller as you go up, we subtract the
+         * active height from the viewport bottom.
+         */
+        return viewportBottom - activeHeight;
+    };
     const gesture = createGesture({
         el: wrapperEl,
         gestureName: 'modalSheet',
@@ -1492,6 +1642,9 @@ const Modal = /*@__PURE__*/ proxyCustomElement(class Modal extends HTMLElement {
         this.willDismissShorthand = createEvent(this, "willDismiss", 7);
         this.didDismissShorthand = createEvent(this, "didDismiss", 7);
         this.ionMount = createEvent(this, "ionMount", 7);
+        this.ionDragStart = createEvent(this, "ionDragStart", 7);
+        this.ionDragMove = createEvent(this, "ionDragMove", 7);
+        this.ionDragEnd = createEvent(this, "ionDragEnd", 7);
         this.lockController = createLockController();
         this.triggerController = createTriggerController();
         this.coreDelegate = CoreDelegate();
@@ -1959,32 +2112,7 @@ const Modal = /*@__PURE__*/ proxyCustomElement(class Modal extends HTMLElement {
             return;
         }
         const statusBarStyle = (_a = this.statusBarStyle) !== null && _a !== void 0 ? _a : Style.Default;
-        this.gesture = createSwipeToCloseGesture(el, ani, statusBarStyle, () => {
-            /**
-             * While the gesture animation is finishing
-             * it is possible for a user to tap the backdrop.
-             * This would result in the dismiss animation
-             * being played again. Typically this is avoided
-             * by setting `presented = false` on the overlay
-             * component; however, we cannot do that here as
-             * that would prevent the element from being
-             * removed from the DOM.
-             */
-            this.gestureAnimationDismissing = true;
-            /**
-             * Reset the status bar style as the dismiss animation
-             * starts otherwise the status bar will be the wrong
-             * color for the duration of the dismiss animation.
-             * The dismiss method does this as well, but
-             * in this case it's only called once the animation
-             * has finished.
-             */
-            setCardStatusBarDefault(this.statusBarStyle);
-            this.animation.onFinish(async () => {
-                await this.dismiss(undefined, GESTURE);
-                this.gestureAnimationDismissing = false;
-            });
-        });
+        this.gesture = createSwipeToCloseGesture(el, ani, statusBarStyle, () => this.cardOnDismiss(), () => this.onDragStart(), (detail) => this.onDragMove(detail), (detail) => this.onDragEnd(detail));
         this.gesture.enable(true);
     }
     initSheetGesture() {
@@ -2005,7 +2133,7 @@ const Modal = /*@__PURE__*/ proxyCustomElement(class Modal extends HTMLElement {
                 this.currentBreakpoint = breakpoint;
                 this.ionBreakpointDidChange.emit({ breakpoint });
             }
-        });
+        }, () => this.onDragStart(), (detail) => this.onDragMove(detail), (detail) => this.onDragEnd(detail));
         this.gesture = gesture;
         this.moveSheetToBreakpoint = moveSheetToBreakpoint;
         this.gesture.enable(true);
@@ -2102,6 +2230,32 @@ const Modal = /*@__PURE__*/ proxyCustomElement(class Modal extends HTMLElement {
             this.gestureAnimationDismissing = false;
         });
     }
+    cardOnDismiss() {
+        /**
+         * While the gesture animation is finishing
+         * it is possible for a user to tap the backdrop.
+         * This would result in the dismiss animation
+         * being played again. Typically this is avoided
+         * by setting `presented = false` on the overlay
+         * component; however, we cannot do that here as
+         * that would prevent the element from being
+         * removed from the DOM.
+         */
+        this.gestureAnimationDismissing = true;
+        /**
+         * Reset the status bar style as the dismiss animation
+         * starts otherwise the status bar will be the wrong
+         * color for the duration of the dismiss animation.
+         * The dismiss method does this as well, but
+         * in this case it's only called once the animation
+         * has finished.
+         */
+        setCardStatusBarDefault(this.statusBarStyle);
+        this.animation.onFinish(async () => {
+            await this.dismiss(undefined, GESTURE);
+            this.gestureAnimationDismissing = false;
+        });
+    }
     /**
      * Dismiss the modal overlay after it has been presented.
      * This is a no-op if the overlay has not been presented yet. If you want
@@ -2417,6 +2571,15 @@ const Modal = /*@__PURE__*/ proxyCustomElement(class Modal extends HTMLElement {
         (_a = this.parentRemovalObserver) === null || _a === void 0 ? void 0 : _a.disconnect();
         this.parentRemovalObserver = undefined;
     }
+    onDragStart() {
+        this.ionDragStart.emit();
+    }
+    onDragMove(detail) {
+        this.ionDragMove.emit(detail);
+    }
+    onDragEnd(detail) {
+        this.ionDragEnd.emit(detail);
+    }
     render() {
         const { handle, isSheetModal, presentingElement, htmlAttributes, handleBehavior, inheritedAttributes, focusTrap, expandToScroll, } = this;
         const showHandle = handle !== false && isSheetModal;
@@ -2424,20 +2587,20 @@ const Modal = /*@__PURE__*/ proxyCustomElement(class Modal extends HTMLElement {
         const isCardModal = presentingElement !== undefined && mode === 'ios';
         const isHandleCycle = handleBehavior === 'cycle';
         const isSheetModalWithHandle = isSheetModal && showHandle;
-        return (h(Host, Object.assign({ key: '87328006ea6c75ebc518ace300438492a567223e', "no-router": true,
+        return (h(Host, Object.assign({ key: 'bca3cbdb2ce8e5127d27eae7494c434aaeddaf88', "no-router": true,
             // Allow the modal to be navigable when the handle is focusable
             tabIndex: isHandleCycle && isSheetModalWithHandle ? 0 : -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, onFocus: this.onModalFocus }), h("ion-backdrop", { key: 'ee94ff8e09b691dd4ad4e4db1720f06bc3c5a469', ref: (el) => (this.backdropEl = el), visible: this.showBackdrop, tappable: this.backdropDismiss, part: "backdrop" }), mode === 'ios' && h("div", { key: 'bffd69b4635c22d9f249725bd952c1e93d5615c7', class: "modal-shadow" }), h("div", Object.assign({ key: '1d394d3c68916e464ff1fbf5242419f4a3d3cca1',
+            }, 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, onFocus: this.onModalFocus }), h("ion-backdrop", { key: 'b1c4112123d84d8a9b9d455bcc17d884f99d9f28', ref: (el) => (this.backdropEl = el), visible: this.showBackdrop, tappable: this.backdropDismiss, part: "backdrop" }), mode === 'ios' && h("div", { key: '080c8e6d37b311a1b5ad2655d99f18668abae211', class: "modal-shadow" }), h("div", Object.assign({ key: '8ba05e9520b1b5529bf0caeb766da5bf612d4d14',
             /*
               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: '2dcf58792018e557e0c323baad2d672bc99c0bb1', 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: '2d2d5d731f55755f32ebcbf557f97486dc6202a6', 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", ref: (el) => (this.dragHandleEl = el) })), h("slot", { key: '44164b1e8710c3895400ad9f44ecd99873874ad5', onSlotchange: this.onSlotChange }))));
+            tabIndex: !isHandleCycle ? -1 : 0, "aria-label": "Activate to adjust the size of the dialog overlaying the screen", onClick: isHandleCycle ? this.onHandleClick : undefined, part: "handle", ref: (el) => (this.dragHandleEl = el) })), h("slot", { key: 'c717d19865dafba02e15db79bc0662c5d89e96fd', onSlotchange: this.onSlotChange }))));
     }
     get el() { return this; }
     static get watchers() { return {