@ionic/core 8.4.4-dev.11741032668.18899f9b → 8.4.4-dev.11741046329.16b83b14

package/dist/collection/components/checkbox/checkbox.js

@@ -13,10 +13,15 @@ import { getIonMode } from "../../global/ionic-global";
  * @part container - The container for the checkbox mark.
  * @part label - The label text describing the checkbox.
  * @part mark - The checkmark used to indicate the checked state.
+ * @part supporting-text - Supporting text displayed beneath the checkbox label.
+ * @part helper-text - Supporting text displayed beneath the checkbox label when the checkbox is valid.
+ * @part error-text - Supporting text displayed beneath the checkbox label when the checkbox is invalid and touched.
  */
 export class Checkbox {
     constructor() {
         this.inputId = `ion-cb-${checkboxIds++}`;
+        this.helperTextId = `${this.inputId}-helper-text`;
+        this.errorTextId = `${this.inputId}-error-text`;
         this.inheritedAttributes = {};
         /**
          * Sets the checked property and emits
@@ -54,10 +59,13 @@ export class Checkbox {
         this.checked = false;
         this.indeterminate = false;
         this.disabled = false;
+        this.errorText = undefined;
+        this.helperText = undefined;
         this.value = 'on';
         this.labelPlacement = 'start';
         this.justify = undefined;
         this.alignment = undefined;
+        this.required = false;
     }
     componentWillLoad() {
         this.inheritedAttributes = Object.assign({}, inheritAriaAttributes(this.el));
@@ -68,12 +76,38 @@ export class Checkbox {
             this.focusEl.focus();
         }
     }
+    getHintTextID() {
+        const { el, helperText, errorText, helperTextId, errorTextId } = this;
+        if (el.classList.contains('ion-touched') && el.classList.contains('ion-invalid') && errorText) {
+            return errorTextId;
+        }
+        if (helperText) {
+            return helperTextId;
+        }
+        return undefined;
+    }
+    /**
+     * Responsible for rendering helper text and error text.
+     * This element should only be rendered if hint text is set.
+     */
+    renderHintText() {
+        const { helperText, errorText, helperTextId, errorTextId } = this;
+        /**
+         * undefined and empty string values should
+         * be treated as not having helper/error text.
+         */
+        const hasHintText = !!helperText || !!errorText;
+        if (!hasHintText) {
+            return;
+        }
+        return (h("div", { class: "checkbox-bottom" }, h("div", { id: helperTextId, class: "helper-text", part: "supporting-text helper-text" }, helperText), h("div", { id: errorTextId, class: "error-text", part: "supporting-text error-text" }, errorText)));
+    }
     render() {
-        const { color, checked, disabled, el, getSVGPath, indeterminate, inheritedAttributes, inputId, justify, labelPlacement, name, value, alignment, } = this;
+        const { color, checked, disabled, el, getSVGPath, indeterminate, inheritedAttributes, inputId, justify, labelPlacement, name, value, alignment, required, } = this;
         const mode = getIonMode(this);
         const path = getSVGPath(mode, indeterminate);
         renderHiddenInput(true, el, name, checked ? value : '', disabled);
-        return (h(Host, { key: '6dc787e1100521d08c4900104e1a3e2f594e919f', "aria-checked": indeterminate ? 'mixed' : `${checked}`, class: createColorClasses(color, {
+        return (h(Host, { key: '7ac31df89b07c781ddcd30a6a8c109494d0c500a', "aria-checked": indeterminate ? 'mixed' : `${checked}`, "aria-describedby": this.getHintTextID(), "aria-invalid": this.getHintTextID() === this.errorTextId, class: createColorClasses(color, {
                 [mode]: true,
                 'in-item': hostContext('ion-item', el),
                 'checkbox-checked': checked,
@@ -83,10 +117,10 @@ export class Checkbox {
                 [`checkbox-justify-${justify}`]: justify !== undefined,
                 [`checkbox-alignment-${alignment}`]: alignment !== undefined,
                 [`checkbox-label-placement-${labelPlacement}`]: true,
-            }), onClick: this.onClick }, h("label", { key: '68222fb736a5ec3f2e488649b0e2ce0417dcb224', class: "checkbox-wrapper" }, h("input", Object.assign({ key: 'f12962d7e9b19c744cfdbdeccc67ae7f5d080281', type: "checkbox", checked: checked ? true : undefined, disabled: disabled, id: inputId, onChange: this.toggleChecked, onFocus: () => this.onFocus(), onBlur: () => this.onBlur(), ref: (focusEl) => (this.focusEl = focusEl) }, inheritedAttributes)), h("div", { key: 'c72df2699414b1e5a41a1bc267bc634f0c93dcff', class: {
+            }), onClick: this.onClick }, h("label", { key: '674e923fe1ec83a33c31d67b0d414d61ba8f9e4b', class: "checkbox-wrapper" }, h("input", Object.assign({ key: 'c4866e392fbdf3b76edcd1507cb67f40a213a4e7', type: "checkbox", checked: checked ? true : undefined, disabled: disabled, id: inputId, onChange: this.toggleChecked, onFocus: () => this.onFocus(), onBlur: () => this.onBlur(), ref: (focusEl) => (this.focusEl = focusEl), required: required }, inheritedAttributes)), h("div", { key: '79cb96e5963b9331a760438ec8cc9e456215de91', class: {
                 'label-text-wrapper': true,
                 'label-text-wrapper-hidden': el.textContent === '',
-            }, part: "label" }, h("slot", { key: 'a2a80285178a7e0e3b536fc9ca26b8b444aa4307' })), h("div", { key: 'c2b05e0d1fe8df5dcd72858220b5ff51ecaee4cc', class: "native-wrapper" }, h("svg", { key: 'ee24913fded72258ebd9713654a6dba92a18fcf7', class: "checkbox-icon", viewBox: "0 0 24 24", part: "container" }, path)))));
+            }, part: "label" }, h("slot", { key: '896cb26292c9a4a6c105afb39611472b93bf5e90' }), this.renderHintText()), h("div", { key: '52cd22e79fd5db30b45d7b092aa5af3944392336', class: "native-wrapper" }, h("svg", { key: '18d862ab7cc32055eaf200eea560ff1b2b6cbde0', class: "checkbox-icon", viewBox: "0 0 24 24", part: "container" }, path)))));
     }
     getSVGPath(mode, indeterminate) {
         let path = indeterminate ? (h("path", { d: "M6 12L18 12", part: "mark" })) : (h("path", { d: "M5.9,12.5l3.8,3.8l8.8-8.8", part: "mark" }));
@@ -206,6 +240,40 @@ export class Checkbox {
                 "reflect": false,
                 "defaultValue": "false"
             },
+            "errorText": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Text that is placed under the checkbox label and displayed when an error is detected."
+                },
+                "attribute": "error-text",
+                "reflect": false
+            },
+            "helperText": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Text that is placed under the checkbox label and displayed when no error is detected."
+                },
+                "attribute": "helper-text",
+                "reflect": false
+            },
             "value": {
                 "type": "any",
                 "mutable": false,
@@ -275,6 +343,24 @@ export class Checkbox {
                 },
                 "attribute": "alignment",
                 "reflect": false
+            },
+            "required": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "If true, screen readers will announce it as a required field. This property\nworks only for accessibility purposes, it will not prevent the form from\nsubmitting if the value is invalid."
+                },
+                "attribute": "required",
+                "reflect": false,
+                "defaultValue": "false"
             }
         };
     }

package/dist/collection/components/checkbox/checkbox.md.css

@@ -189,32 +189,39 @@ input {
   opacity: 0;
 }
 
-:host(.checkbox-justify-space-between) .checkbox-wrapper {
+.checkbox-bottom {
+  padding-top: 4px;
+  display: flex;
   justify-content: space-between;
+  font-size: 0.75rem;
+  white-space: normal;
 }
 
-:host(.checkbox-justify-start) .checkbox-wrapper {
-  justify-content: start;
+:host(.checkbox-label-placement-stacked) .checkbox-bottom {
+  font-size: 1rem;
 }
 
-:host(.checkbox-justify-end) .checkbox-wrapper {
-  justify-content: end;
+/**
+ * Error text should only be shown when .ion-invalid is
+ * present on the checkbox. Otherwise the helper text should
+ * be shown.
+ */
+.checkbox-bottom .error-text {
+  display: none;
+  color: var(--ion-color-danger, #c5000f);
 }
 
-:host(.checkbox-alignment-start) .checkbox-wrapper {
-  align-items: start;
+.checkbox-bottom .helper-text {
+  display: block;
+  color: var(--ion-color-step-700, var(--ion-text-color-step-300, #4d4d4d));
 }
 
-:host(.checkbox-alignment-center) .checkbox-wrapper {
-  align-items: center;
+:host(.ion-touched.ion-invalid) .checkbox-bottom .error-text {
+  display: block;
 }
 
-:host(.checkbox-justify-space-between),
-:host(.checkbox-justify-start),
-:host(.checkbox-justify-end),
-:host(.checkbox-alignment-start),
-:host(.checkbox-alignment-center) {
-  display: block;
+:host(.ion-touched.ion-invalid) .checkbox-bottom .helper-text {
+  display: none;
 }
 
 /**
@@ -243,6 +250,7 @@ input {
  */
 :host(.checkbox-label-placement-end) .checkbox-wrapper {
   flex-direction: row-reverse;
+  justify-content: start;
 }
 
 /**
@@ -285,6 +293,7 @@ input {
  */
 :host(.checkbox-label-placement-stacked) .checkbox-wrapper {
   flex-direction: column;
+  text-align: center;
 }
 
 :host(.checkbox-label-placement-stacked) .label-text-wrapper {
@@ -330,6 +339,34 @@ input {
   }
 }
 
+:host(.checkbox-justify-space-between) .checkbox-wrapper {
+  justify-content: space-between;
+}
+
+:host(.checkbox-justify-start) .checkbox-wrapper {
+  justify-content: start;
+}
+
+:host(.checkbox-justify-end) .checkbox-wrapper {
+  justify-content: end;
+}
+
+:host(.checkbox-alignment-start) .checkbox-wrapper {
+  align-items: start;
+}
+
+:host(.checkbox-alignment-center) .checkbox-wrapper {
+  align-items: center;
+}
+
+:host(.checkbox-justify-space-between),
+:host(.checkbox-justify-start),
+:host(.checkbox-justify-end),
+:host(.checkbox-alignment-start),
+:host(.checkbox-alignment-center) {
+  display: block;
+}
+
 :host(.checkbox-checked) .checkbox-icon,
 :host(.checkbox-indeterminate) .checkbox-icon {
   border-color: var(--border-color-checked);

package/dist/collection/components/modal/animations/ios.enter.js

@@ -13,22 +13,68 @@ const createEnterAnimation = () => {
     })
         .afterClearStyles(['pointer-events']);
     const wrapperAnimation = createAnimation().fromTo('transform', 'translateY(100vh)', 'translateY(0vh)');
-    return { backdropAnimation, wrapperAnimation };
+    return { backdropAnimation, wrapperAnimation, contentAnimation: undefined };
 };
 /**
  * iOS Modal Enter Animation for the Card presentation style
  */
 export const iosEnterAnimation = (baseEl, opts) => {
-    const { presentingEl, currentBreakpoint } = opts;
+    const { presentingEl, currentBreakpoint, expandToScroll } = opts;
     const root = getElementRoot(baseEl);
-    const { wrapperAnimation, backdropAnimation } = currentBreakpoint !== undefined ? createSheetEnterAnimation(opts) : createEnterAnimation();
+    const { wrapperAnimation, backdropAnimation, contentAnimation } = currentBreakpoint !== undefined ? createSheetEnterAnimation(opts) : createEnterAnimation();
     backdropAnimation.addElement(root.querySelector('ion-backdrop'));
     wrapperAnimation.addElement(root.querySelectorAll('.modal-wrapper, .modal-shadow')).beforeStyles({ opacity: 1 });
+    // The content animation is only added if scrolling is enabled for
+    // all the breakpoints.
+    !expandToScroll && (contentAnimation === null || contentAnimation === void 0 ? void 0 : contentAnimation.addElement(baseEl.querySelector('.ion-page')));
     const baseAnimation = createAnimation('entering-base')
         .addElement(baseEl)
         .easing('cubic-bezier(0.32,0.72,0,1)')
         .duration(500)
-        .addAnimation(wrapperAnimation);
+        .addAnimation([wrapperAnimation])
+        .beforeAddWrite(() => {
+        if (expandToScroll) {
+            // Scroll can only be done when the modal is fully expanded.
+            return;
+        }
+        /**
+         * There are some browsers that causes flickering when
+         * dragging the content when scroll is enabled at every
+         * breakpoint. This is due to the wrapper element being
+         * transformed off the screen and having a snap animation.
+         *
+         * A workaround is to clone the footer element and append
+         * it outside of the wrapper element. This way, the footer
+         * is still visible and the drag can be done without
+         * flickering. The original footer is hidden until the modal
+         * is dismissed. This maintains the animation of the footer
+         * when the modal is dismissed.
+         *
+         * The workaround needs to be done before the animation starts
+         * so there are no flickering issues.
+         */
+        const ionFooter = baseEl.querySelector('ion-footer');
+        /**
+         * This check is needed to prevent more than one footer
+         * from being appended to the shadow root.
+         * Otherwise, iOS and MD enter animations would append
+         * the footer twice.
+         */
+        const ionFooterAlreadyAppended = baseEl.shadowRoot.querySelector('ion-footer');
+        if (ionFooter && !ionFooterAlreadyAppended) {
+            const footerHeight = ionFooter.clientHeight;
+            const clonedFooter = ionFooter.cloneNode(true);
+            baseEl.shadowRoot.appendChild(clonedFooter);
+            ionFooter.style.setProperty('display', 'none');
+            ionFooter.setAttribute('aria-hidden', 'true');
+            // Padding is added to prevent some content from being hidden.
+            const page = baseEl.querySelector('.ion-page');
+            page.style.setProperty('padding-bottom', `${footerHeight}px`);
+        }
+    });
+    if (contentAnimation) {
+        baseAnimation.addAnimation(contentAnimation);
+    }
     if (presentingEl) {
         const isMobile = window.innerWidth < 768;
         const hasCardModal = presentingEl.tagName === 'ION-MODAL' && presentingEl.presentingElement !== undefined;

package/dist/collection/components/modal/animations/ios.leave.js

@@ -14,7 +14,7 @@ const createLeaveAnimation = () => {
  * iOS Modal Leave Animation
  */
 export const iosLeaveAnimation = (baseEl, opts, duration = 500) => {
-    const { presentingEl, currentBreakpoint } = opts;
+    const { presentingEl, currentBreakpoint, expandToScroll } = opts;
     const root = getElementRoot(baseEl);
     const { wrapperAnimation, backdropAnimation } = currentBreakpoint !== undefined ? createSheetLeaveAnimation(opts) : createLeaveAnimation();
     backdropAnimation.addElement(root.querySelector('ion-backdrop'));
@@ -23,7 +23,29 @@ export const iosLeaveAnimation = (baseEl, opts, duration = 500) => {
         .addElement(baseEl)
         .easing('cubic-bezier(0.32,0.72,0,1)')
         .duration(duration)
-        .addAnimation(wrapperAnimation);
+        .addAnimation(wrapperAnimation)
+        .beforeAddWrite(() => {
+        if (expandToScroll) {
+            // Scroll can only be done when the modal is fully expanded.
+            return;
+        }
+        /**
+         * If expandToScroll is disabled, we need to swap
+         * the visibility to the original, so the footer
+         * dismisses with the modal and doesn't stay
+         * until the modal is removed from the DOM.
+         */
+        const ionFooter = baseEl.querySelector('ion-footer');
+        if (ionFooter) {
+            const clonedFooter = baseEl.shadowRoot.querySelector('ion-footer');
+            ionFooter.style.removeProperty('display');
+            ionFooter.removeAttribute('aria-hidden');
+            clonedFooter.style.setProperty('display', 'none');
+            clonedFooter.setAttribute('aria-hidden', 'true');
+            const page = baseEl.querySelector('.ion-page');
+            page.style.removeProperty('padding-bottom');
+        }
+    });
     if (presentingEl) {
         const isMobile = window.innerWidth < 768;
         const hasCardModal = presentingEl.tagName === 'ION-MODAL' && presentingEl.presentingElement !== undefined;

package/dist/collection/components/modal/animations/md.enter.js

@@ -15,20 +15,67 @@ const createEnterAnimation = () => {
         { offset: 0, opacity: 0.01, transform: 'translateY(40px)' },
         { offset: 1, opacity: 1, transform: `translateY(0px)` },
     ]);
-    return { backdropAnimation, wrapperAnimation };
+    return { backdropAnimation, wrapperAnimation, contentAnimation: undefined };
 };
 /**
  * Md Modal Enter Animation
  */
 export const mdEnterAnimation = (baseEl, opts) => {
-    const { currentBreakpoint } = opts;
+    const { currentBreakpoint, expandToScroll } = opts;
     const root = getElementRoot(baseEl);
-    const { wrapperAnimation, backdropAnimation } = currentBreakpoint !== undefined ? createSheetEnterAnimation(opts) : createEnterAnimation();
+    const { wrapperAnimation, backdropAnimation, contentAnimation } = currentBreakpoint !== undefined ? createSheetEnterAnimation(opts) : createEnterAnimation();
     backdropAnimation.addElement(root.querySelector('ion-backdrop'));
     wrapperAnimation.addElement(root.querySelector('.modal-wrapper'));
-    return createAnimation()
+    // The content animation is only added if scrolling is enabled for
+    // all the breakpoints.
+    expandToScroll && (contentAnimation === null || contentAnimation === void 0 ? void 0 : contentAnimation.addElement(baseEl.querySelector('.ion-page')));
+    const baseAnimation = createAnimation()
         .addElement(baseEl)
         .easing('cubic-bezier(0.36,0.66,0.04,1)')
         .duration(280)
-        .addAnimation([backdropAnimation, wrapperAnimation]);
+        .addAnimation([backdropAnimation, wrapperAnimation])
+        .beforeAddWrite(() => {
+        if (expandToScroll) {
+            // Scroll can only be done when the modal is fully expanded.
+            return;
+        }
+        /**
+         * There are some browsers that causes flickering when
+         * dragging the content when scroll is enabled at every
+         * breakpoint. This is due to the wrapper element being
+         * transformed off the screen and having a snap animation.
+         *
+         * A workaround is to clone the footer element and append
+         * it outside of the wrapper element. This way, the footer
+         * is still visible and the drag can be done without
+         * flickering. The original footer is hidden until the modal
+         * is dismissed. This maintains the animation of the footer
+         * when the modal is dismissed.
+         *
+         * The workaround needs to be done before the animation starts
+         * so there are no flickering issues.
+         */
+        const ionFooter = baseEl.querySelector('ion-footer');
+        /**
+         * This check is needed to prevent more than one footer
+         * from being appended to the shadow root.
+         * Otherwise, iOS and MD enter animations would append
+         * the footer twice.
+         */
+        const ionFooterAlreadyAppended = baseEl.shadowRoot.querySelector('ion-footer');
+        if (ionFooter && !ionFooterAlreadyAppended) {
+            const footerHeight = ionFooter.clientHeight;
+            const clonedFooter = ionFooter.cloneNode(true);
+            baseEl.shadowRoot.appendChild(clonedFooter);
+            ionFooter.style.setProperty('display', 'none');
+            ionFooter.setAttribute('aria-hidden', 'true');
+            // Padding is added to prevent some content from being hidden.
+            const page = baseEl.querySelector('.ion-page');
+            page.style.setProperty('padding-bottom', `${footerHeight}px`);
+        }
+    });
+    if (contentAnimation) {
+        baseAnimation.addAnimation(contentAnimation);
+    }
+    return baseAnimation;
 };

package/dist/collection/components/modal/animations/md.leave.js

@@ -16,13 +16,36 @@ const createLeaveAnimation = () => {
  * Md Modal Leave Animation
  */
 export const mdLeaveAnimation = (baseEl, opts) => {
-    const { currentBreakpoint } = opts;
+    const { currentBreakpoint, expandToScroll } = opts;
     const root = getElementRoot(baseEl);
     const { wrapperAnimation, backdropAnimation } = currentBreakpoint !== undefined ? createSheetLeaveAnimation(opts) : createLeaveAnimation();
     backdropAnimation.addElement(root.querySelector('ion-backdrop'));
     wrapperAnimation.addElement(root.querySelector('.modal-wrapper'));
-    return createAnimation()
+    const baseAnimation = createAnimation()
         .easing('cubic-bezier(0.47,0,0.745,0.715)')
         .duration(200)
-        .addAnimation([backdropAnimation, wrapperAnimation]);
+        .addAnimation([backdropAnimation, wrapperAnimation])
+        .beforeAddWrite(() => {
+        if (expandToScroll) {
+            // Scroll can only be done when the modal is fully expanded.
+            return;
+        }
+        /**
+         * If expandToScroll is disabled, we need to swap
+         * the visibility to the original, so the footer
+         * dismisses with the modal and doesn't stay
+         * until the modal is removed from the DOM.
+         */
+        const ionFooter = baseEl.querySelector('ion-footer');
+        if (ionFooter) {
+            const clonedFooter = baseEl.shadowRoot.querySelector('ion-footer');
+            ionFooter.style.removeProperty('display');
+            ionFooter.removeAttribute('aria-hidden');
+            clonedFooter.style.setProperty('display', 'none');
+            clonedFooter.setAttribute('aria-hidden', 'true');
+            const page = baseEl.querySelector('.ion-page');
+            page.style.removeProperty('padding-bottom');
+        }
+    });
+    return baseAnimation;
 };

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

@@ -4,7 +4,7 @@
 import { createAnimation } from "../../../utils/animation/animation";
 import { getBackdropValueForSheet } from "../utils";
 export const createSheetEnterAnimation = (opts) => {
-    const { currentBreakpoint, backdropBreakpoint } = opts;
+    const { currentBreakpoint, backdropBreakpoint, expandToScroll } = opts;
     /**
      * If the backdropBreakpoint is undefined, then the backdrop
      * should always fade in. If the backdropBreakpoint came before the
@@ -24,7 +24,16 @@ export const createSheetEnterAnimation = (opts) => {
         { offset: 0, opacity: 1, transform: 'translateY(100%)' },
         { offset: 1, opacity: 1, transform: `translateY(${100 - currentBreakpoint * 100}%)` },
     ]);
-    return { wrapperAnimation, backdropAnimation };
+    /**
+     * This allows the content to be scrollable at any breakpoint.
+     */
+    const contentAnimation = !expandToScroll
+        ? createAnimation('contentAnimation').keyframes([
+            { offset: 0, opacity: 1, maxHeight: `${(1 - currentBreakpoint) * 100}%` },
+            { offset: 1, opacity: 1, maxHeight: `${currentBreakpoint * 100}%` },
+        ])
+        : undefined;
+    return { wrapperAnimation, backdropAnimation, contentAnimation };
 };
 export const createSheetLeaveAnimation = (opts) => {
     const { currentBreakpoint, backdropBreakpoint } = opts;