@ionic/core 8.8.19 → 8.8.20-dev.11787158518.168a2fea

package/dist/collection/components/toast/toast.js

@@ -31,103 +31,126 @@ import { createSwipeToDismissGesture } from "./gestures/swipe-to-dismiss";
  * @part button cancel - Any button element with role "cancel" that is displayed inside of the toast.
  */
 export class Toast {
-    constructor() {
-        this.delegateController = createDelegateController(this);
-        this.lockController = createLockController();
-        this.triggerController = createTriggerController();
-        this.customHTMLEnabled = config.get('innerHTMLTemplatesEnabled', ENABLE_HTML_CONTENT_DEFAULT);
-        this.presented = false;
-        /**
-         * When `true`, content inside of .toast-content
-         * will have aria-hidden elements removed causing
-         * screen readers to announce the remaining content.
-         */
-        this.revealContentToScreenReader = false;
-        /** @internal */
-        this.hasController = false;
-        /**
-         * How many milliseconds to wait before hiding the toast. By default, it will show
-         * until `dismiss()` is called.
-         */
-        this.duration = config.getNumber('toastDuration', 0);
-        /**
-         * Defines how the message and buttons are laid out in the toast.
-         * 'baseline': The message and the buttons will appear on the same line.
-         * Message text may wrap within the message container.
-         * 'stacked': The buttons containers and message will stack on top
-         * of each other. Use this if you have long text in your buttons.
-         */
-        this.layout = 'baseline';
-        /**
-         * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
-         */
-        this.keyboardClose = false;
-        /**
-         * The starting position of the toast on the screen. Can be tweaked further
-         * using the `positionAnchor` property.
-         */
-        this.position = 'bottom';
-        /**
-         * If `true`, the toast will be translucent.
-         * Only applies when the mode is `"ios"` and the device supports
-         * [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
-         */
-        this.translucent = false;
-        /**
-         * If `true`, the toast will animate.
-         */
-        this.animated = true;
-        /**
-         * If `true`, the toast will open. If `false`, the toast will close.
-         * Use this if you need finer grained control over presentation, otherwise
-         * just use the toastController or the `trigger` property.
-         * Note: `isOpen` will not automatically be set back to `false` when
-         * the toast dismisses. You will need to do that in your code.
-         */
-        this.isOpen = false;
-        this.dispatchCancelHandler = (ev) => {
-            const role = ev.detail.role;
-            if (isCancel(role)) {
-                const cancelButton = this.getButtons().find((b) => b.role === 'cancel');
-                this.callButtonHandler(cancelButton);
-            }
-        };
-        /**
-         * Create a new swipe gesture so Toast
-         * can be swiped to dismiss.
-         */
-        this.createSwipeGesture = (toastPosition) => {
-            const gesture = (this.gesture = createSwipeToDismissGesture(this.el, toastPosition, () => {
-                /**
-                 * If the gesture completed then
-                 * we should dismiss the toast.
-                 */
-                this.dismiss(undefined, GESTURE);
-            }));
-            gesture.enable(true);
-        };
-        /**
-         * Destroy an existing swipe gesture
-         * so Toast can no longer be swiped to dismiss.
-         */
-        this.destroySwipeGesture = () => {
-            const { gesture } = this;
-            if (gesture === undefined) {
-                return;
-            }
-            gesture.destroy();
-            this.gesture = undefined;
-        };
-        /**
-         * Returns `true` if swipeGesture
-         * is configured to a value that enables the swipe behavior.
-         * Returns `false` otherwise.
-         */
-        this.prefersSwipeGesture = () => {
-            const { swipeGesture } = this;
-            return swipeGesture === 'vertical';
-        };
-    }
+    delegateController = createDelegateController(this);
+    lockController = createLockController();
+    triggerController = createTriggerController();
+    customHTMLEnabled = config.get('innerHTMLTemplatesEnabled', ENABLE_HTML_CONTENT_DEFAULT);
+    durationTimeout;
+    gesture;
+    /**
+     * Holds the position of the toast calculated in the present
+     * animation, to be passed along to the dismiss animation so
+     * we don't have to calculate the position twice.
+     */
+    lastPresentedPosition;
+    presented = false;
+    /**
+     * When `true`, content inside of .toast-content
+     * will have aria-hidden elements removed causing
+     * screen readers to announce the remaining content.
+     */
+    revealContentToScreenReader = false;
+    el;
+    /**
+     * @internal
+     */
+    overlayIndex;
+    /** @internal */
+    delegate;
+    /** @internal */
+    hasController = false;
+    /**
+     * The color to use from your application's color palette.
+     * Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
+     * For more information on colors, see [theming](/docs/theming/basics).
+     */
+    color;
+    /**
+     * Animation to use when the toast is presented.
+     */
+    enterAnimation;
+    /**
+     * Animation to use when the toast is dismissed.
+     */
+    leaveAnimation;
+    /**
+     * Additional classes to apply for custom CSS. If multiple classes are
+     * provided they should be separated by spaces.
+     */
+    cssClass;
+    /**
+     * How many milliseconds to wait before hiding the toast. By default, it will show
+     * until `dismiss()` is called.
+     */
+    duration = config.getNumber('toastDuration', 0);
+    /**
+     * Header to be shown in the toast.
+     */
+    header;
+    /**
+     * Defines how the message and buttons are laid out in the toast.
+     * 'baseline': The message and the buttons will appear on the same line.
+     * Message text may wrap within the message container.
+     * 'stacked': The buttons containers and message will stack on top
+     * of each other. Use this if you have long text in your buttons.
+     */
+    layout = 'baseline';
+    /**
+     * Message to be shown in the toast.
+     * This property accepts custom HTML as a string.
+     * Content is parsed as plaintext by default.
+     * `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config
+     * before custom HTML can be used.
+     */
+    message;
+    /**
+     * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
+     */
+    keyboardClose = false;
+    /**
+     * The starting position of the toast on the screen. Can be tweaked further
+     * using the `positionAnchor` property.
+     */
+    position = 'bottom';
+    /**
+     * The element to anchor the toast's position to. Can be set as a direct reference
+     * or the ID of the element. With `position="bottom"`, the toast will sit above the
+     * chosen element. With `position="top"`, the toast will sit below the chosen element.
+     * With `position="middle"`, the value of `positionAnchor` is ignored.
+     */
+    positionAnchor;
+    /**
+     * An array of buttons for the toast.
+     */
+    buttons;
+    /**
+     * If `true`, the toast will be translucent.
+     * Only applies when the mode is `"ios"` and the device supports
+     * [`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility).
+     */
+    translucent = false;
+    /**
+     * If `true`, the toast will animate.
+     */
+    animated = true;
+    /**
+     * The name of the icon to display, or the path to a valid SVG file. See `ion-icon`.
+     * https://ionic.io/ionicons
+     */
+    icon;
+    /**
+     * Additional attributes to pass to the toast.
+     */
+    htmlAttributes;
+    /**
+     * If set to 'vertical', the Toast can be dismissed with
+     * a swipe gesture. The swipe direction is determined by
+     * the value of the `position` property:
+     * `top`: The Toast can be swiped up to dismiss.
+     * `bottom`: The Toast can be swiped down to dismiss.
+     * `middle`: The Toast can be swiped up or down to dismiss.
+     */
+    swipeGesture;
     swipeGestureChanged() {
         /**
          * If the Toast is presented, then we need to destroy
@@ -155,6 +178,14 @@ export class Toast {
             this.createSwipeGesture(this.lastPresentedPosition);
         }
     }
+    /**
+     * If `true`, the toast will open. If `false`, the toast will close.
+     * Use this if you need finer grained control over presentation, otherwise
+     * just use the toastController or the `trigger` property.
+     * Note: `isOpen` will not automatically be set back to `false` when
+     * the toast dismisses. You will need to do that in your code.
+     */
+    isOpen = false;
     onIsOpenChange(newValue, oldValue) {
         if (newValue === true && oldValue === false) {
             this.present();
@@ -163,12 +194,53 @@ export class Toast {
             this.dismiss();
         }
     }
+    /**
+     * An ID corresponding to the trigger element that
+     * causes the toast to open when clicked.
+     */
+    trigger;
     triggerChanged() {
         const { trigger, el, triggerController } = this;
         if (trigger) {
             triggerController.addClickListener(el, trigger);
         }
     }
+    /**
+     * Emitted after the toast has presented.
+     */
+    didPresent;
+    /**
+     * Emitted before the toast has presented.
+     */
+    willPresent;
+    /**
+     * Emitted before the toast has dismissed.
+     */
+    willDismiss;
+    /**
+     * Emitted after the toast has dismissed.
+     */
+    didDismiss;
+    /**
+     * Emitted after the toast has presented.
+     * Shorthand for ionToastWillDismiss.
+     */
+    didPresentShorthand;
+    /**
+     * Emitted before the toast has presented.
+     * Shorthand for ionToastWillPresent.
+     */
+    willPresentShorthand;
+    /**
+     * Emitted before the toast has dismissed.
+     * Shorthand for ionToastWillDismiss.
+     */
+    willDismissShorthand;
+    /**
+     * Emitted after the toast has dismissed.
+     * Shorthand for ionToastDidDismiss.
+     */
+    didDismissShorthand;
     connectedCallback() {
         prepareOverlay(this.el);
         this.triggerChanged();
@@ -177,8 +249,7 @@ export class Toast {
         this.triggerController.removeClickListener();
     }
     componentWillLoad() {
-        var _a;
-        if (!((_a = this.htmlAttributes) === null || _a === void 0 ? void 0 : _a.id)) {
+        if (!this.htmlAttributes?.id) {
             setOverlayId(this.el);
         }
     }
@@ -252,7 +323,6 @@ export class Toast {
      * Some examples include: `"cancel"`, `"destructive"`, `"selected"`, and `"backdrop"`.
      */
     async dismiss(data, role) {
-        var _a, _b;
         const unlock = await this.lockController.lock();
         const { durationTimeout, position, lastPresentedPosition } = this;
         if (durationTimeout) {
@@ -266,8 +336,8 @@ export class Toast {
          */
         {
             position,
-            top: (_a = lastPresentedPosition === null || lastPresentedPosition === void 0 ? void 0 : lastPresentedPosition.top) !== null && _a !== void 0 ? _a : '',
-            bottom: (_b = lastPresentedPosition === null || lastPresentedPosition === void 0 ? void 0 : lastPresentedPosition.bottom) !== null && _b !== void 0 ? _b : '',
+            top: lastPresentedPosition?.top ?? '',
+            bottom: lastPresentedPosition?.bottom ?? '',
         });
         if (dismissed) {
             this.delegateController.removeViewFromDom();
@@ -352,7 +422,7 @@ export class Toast {
         return Promise.resolve();
     }
     async callButtonHandler(button) {
-        if (button === null || button === void 0 ? void 0 : button.handler) {
+        if (button?.handler) {
             // a handler has been provided, execute it
             // pass the handler the values from the inputs
             try {
@@ -368,6 +438,48 @@ export class Toast {
         }
         return true;
     }
+    dispatchCancelHandler = (ev) => {
+        const role = ev.detail.role;
+        if (isCancel(role)) {
+            const cancelButton = this.getButtons().find((b) => b.role === 'cancel');
+            this.callButtonHandler(cancelButton);
+        }
+    };
+    /**
+     * Create a new swipe gesture so Toast
+     * can be swiped to dismiss.
+     */
+    createSwipeGesture = (toastPosition) => {
+        const gesture = (this.gesture = createSwipeToDismissGesture(this.el, toastPosition, () => {
+            /**
+             * If the gesture completed then
+             * we should dismiss the toast.
+             */
+            this.dismiss(undefined, GESTURE);
+        }));
+        gesture.enable(true);
+    };
+    /**
+     * Destroy an existing swipe gesture
+     * so Toast can no longer be swiped to dismiss.
+     */
+    destroySwipeGesture = () => {
+        const { gesture } = this;
+        if (gesture === undefined) {
+            return;
+        }
+        gesture.destroy();
+        this.gesture = undefined;
+    };
+    /**
+     * Returns `true` if swipeGesture
+     * is configured to a value that enables the swipe behavior.
+     * Returns `false` otherwise.
+     */
+    prefersSwipeGesture = () => {
+        const { swipeGesture } = this;
+        return swipeGesture === 'vertical';
+    };
     renderButtons(buttons, side) {
         if (buttons.length === 0) {
             return;
@@ -377,7 +489,7 @@ export class Toast {
             'toast-button-group': true,
             [`toast-button-group-${side}`]: true,
         };
-        return (h("div", { class: buttonGroupsClasses }, buttons.map((b) => (h("button", Object.assign({}, b.htmlAttributes, { type: "button", class: buttonClass(b), tabIndex: 0, onClick: () => this.buttonClick(b), part: buttonPart(b) }), h("div", { class: "toast-button-inner" }, b.icon && (h("ion-icon", { "aria-hidden": "true", icon: b.icon, slot: b.text === undefined ? 'icon-only' : undefined, class: "toast-button-icon" })), b.text), mode === 'md' && (h("ion-ripple-effect", { type: b.icon !== undefined && b.text === undefined ? 'unbounded' : 'bounded' })))))));
+        return (h("div", { class: buttonGroupsClasses }, buttons.map((b) => (h("button", { ...b.htmlAttributes, type: "button", class: buttonClass(b), tabIndex: 0, onClick: () => this.buttonClick(b), part: buttonPart(b) }, h("div", { class: "toast-button-inner" }, b.icon && (h("ion-icon", { "aria-hidden": "true", icon: b.icon, slot: b.text === undefined ? 'icon-only' : undefined, class: "toast-button-icon" })), b.text), mode === 'md' && (h("ion-ripple-effect", { type: b.icon !== undefined && b.text === undefined ? 'unbounded' : 'bounded' })))))));
     }
     /**
      * Render the `message` property.
@@ -417,9 +529,14 @@ export class Toast {
         if (layout === 'stacked' && startButtons.length > 0 && endButtons.length > 0) {
             printIonWarning('[ion-toast] - This toast is using start and end buttons with the stacked toast layout. We recommend following the best practice of using either start or end buttons with the stacked toast layout.', el);
         }
-        return (h(Host, Object.assign({ key: 'b5256edcf33d0ef51e6c5080c84e1ca58abe2ae0', tabindex: "-1" }, this.htmlAttributes, { style: {
+        return (h(Host, { key: '15d2ff8b689e40bb5cae3e304448dadf91b11b88', tabindex: "-1", ...this.htmlAttributes, style: {
                 zIndex: `${60000 + this.overlayIndex}`,
-            }, class: createColorClasses(this.color, Object.assign(Object.assign({ [mode]: true }, getClassMap(this.cssClass)), { 'overlay-hidden': true, 'toast-translucent': this.translucent })), onIonToastWillDismiss: this.dispatchCancelHandler }), h("div", { key: '0860f7e895d8bc66e44c4d924ca569f4cbb1a749', class: wrapperClass, part: "wrapper" }, h("div", { key: '28784199c880a3f664677c8f5560b7caa8903251', class: "toast-container", part: "container" }, this.renderButtons(startButtons, 'start'), this.icon !== undefined && (h("ion-icon", { key: '0a63ba1336ad43d2aec14e49055eb46c112359c2', class: "toast-icon", part: "icon", icon: this.icon, lazy: false, "aria-hidden": "true" })), h("div", { key: 'ecec8107af582dc55d4b3828dd7f3054a29f26b1', class: "toast-content", part: "content", role: "status", "aria-atomic": "true", "aria-live": "polite" }, !revealContentToScreenReader && header !== undefined && this.renderHeader('oldHeader', 'true'), !revealContentToScreenReader && message !== undefined && this.renderToastMessage('oldMessage', 'true'), revealContentToScreenReader && header !== undefined && this.renderHeader('header'), revealContentToScreenReader && message !== undefined && this.renderToastMessage('header')), this.renderButtons(endButtons, 'end')))));
+            }, class: createColorClasses(this.color, {
+                [mode]: true,
+                ...getClassMap(this.cssClass),
+                'overlay-hidden': true,
+                'toast-translucent': this.translucent,
+            }), onIonToastWillDismiss: this.dispatchCancelHandler }, h("div", { key: 'd26cc17a59e3d81810e22ee422398f2cc4c7a05c', class: wrapperClass, part: "wrapper" }, h("div", { key: 'f15e1a97f13defcbf96612df4c7ba45999e6244d', class: "toast-container", part: "container" }, this.renderButtons(startButtons, 'start'), this.icon !== undefined && (h("ion-icon", { key: '639cacec828f969673071e54dc68284050e9f2fd', class: "toast-icon", part: "icon", icon: this.icon, lazy: false, "aria-hidden": "true" })), h("div", { key: 'a07e68cf68e4c507e4515de1a4b43dd8fb3541d3', class: "toast-content", part: "content", role: "status", "aria-atomic": "true", "aria-live": "polite" }, !revealContentToScreenReader && header !== undefined && this.renderHeader('oldHeader', 'true'), !revealContentToScreenReader && message !== undefined && this.renderToastMessage('oldMessage', 'true'), revealContentToScreenReader && header !== undefined && this.renderHeader('header'), revealContentToScreenReader && message !== undefined && this.renderToastMessage('header')), this.renderButtons(endButtons, 'end')))));
     }
     static get is() { return "ion-toast"; }
     static get encapsulation() { return "shadow"; }