@ionic/core 8.5.4-dev.11744052844.17c6a004 → 8.5.4-dev.11744209290.123af9eb

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

@@ -35,6 +35,54 @@ export class Toast {
         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)) {
@@ -77,29 +125,6 @@ export class Toast {
             const { swipeGesture } = this;
             return swipeGesture === 'vertical';
         };
-        this.revealContentToScreenReader = false;
-        this.overlayIndex = undefined;
-        this.delegate = undefined;
-        this.hasController = false;
-        this.color = undefined;
-        this.enterAnimation = undefined;
-        this.leaveAnimation = undefined;
-        this.cssClass = undefined;
-        this.duration = config.getNumber('toastDuration', 0);
-        this.header = undefined;
-        this.layout = 'baseline';
-        this.message = undefined;
-        this.keyboardClose = false;
-        this.position = 'bottom';
-        this.positionAnchor = undefined;
-        this.buttons = undefined;
-        this.translucent = false;
-        this.animated = true;
-        this.icon = undefined;
-        this.htmlAttributes = undefined;
-        this.swipeGesture = undefined;
-        this.isOpen = false;
-        this.trigger = undefined;
     }
     swipeGestureChanged() {
         /**
@@ -413,6 +438,7 @@ export class Toast {
         return {
             "overlayIndex": {
                 "type": "number",
+                "attribute": "overlay-index",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -428,11 +454,13 @@ export class Toast {
                         }],
                     "text": ""
                 },
-                "attribute": "overlay-index",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "delegate": {
                 "type": "unknown",
+                "attribute": "delegate",
                 "mutable": false,
                 "complexType": {
                     "original": "FrameworkDelegate",
@@ -453,10 +481,13 @@ export class Toast {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "hasController": {
                 "type": "boolean",
+                "attribute": "has-controller",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -472,12 +503,14 @@ export class Toast {
                         }],
                     "text": ""
                 },
-                "attribute": "has-controller",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -496,11 +529,13 @@ export class Toast {
                     "tags": [],
                     "text": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
                 },
-                "attribute": "color",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "enterAnimation": {
                 "type": "unknown",
+                "attribute": "enter-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -518,10 +553,13 @@ export class Toast {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the toast is presented."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "leaveAnimation": {
                 "type": "unknown",
+                "attribute": "leave-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -539,10 +577,13 @@ export class Toast {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the toast is dismissed."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "cssClass": {
                 "type": "string",
+                "attribute": "css-class",
                 "mutable": false,
                 "complexType": {
                     "original": "string | string[]",
@@ -555,11 +596,13 @@ export class Toast {
                     "tags": [],
                     "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
             },
             "duration": {
                 "type": "number",
+                "attribute": "duration",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -572,12 +615,14 @@ export class Toast {
                     "tags": [],
                     "text": "How many milliseconds to wait before hiding the toast. By default, it will show\nuntil `dismiss()` is called."
                 },
-                "attribute": "duration",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "config.getNumber('toastDuration', 0)"
             },
             "header": {
                 "type": "string",
+                "attribute": "header",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -590,11 +635,13 @@ export class Toast {
                     "tags": [],
                     "text": "Header to be shown in the toast."
                 },
-                "attribute": "header",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "layout": {
                 "type": "string",
+                "attribute": "layout",
                 "mutable": false,
                 "complexType": {
                     "original": "ToastLayout",
@@ -613,12 +660,14 @@ export class Toast {
                     "tags": [],
                     "text": "Defines how the message and buttons are laid out in the toast.\n'baseline': The message and the buttons will appear on the same line.\nMessage text may wrap within the message container.\n'stacked': The buttons containers and message will stack on top\nof each other. Use this if you have long text in your buttons."
                 },
-                "attribute": "layout",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'baseline'"
             },
             "message": {
                 "type": "string",
+                "attribute": "message",
                 "mutable": false,
                 "complexType": {
                     "original": "string | IonicSafeString",
@@ -637,11 +686,13 @@ export class Toast {
                     "tags": [],
                     "text": "Message to be shown in the toast.\nThis property accepts custom HTML as a string.\nContent is parsed as plaintext by default.\n`innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config\nbefore custom HTML can be used."
                 },
-                "attribute": "message",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "keyboardClose": {
                 "type": "boolean",
+                "attribute": "keyboard-close",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -654,12 +705,14 @@ export class Toast {
                     "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": "false"
             },
             "position": {
                 "type": "string",
+                "attribute": "position",
                 "mutable": false,
                 "complexType": {
                     "original": "ToastPosition",
@@ -678,12 +731,14 @@ export class Toast {
                     "tags": [],
                     "text": "The starting position of the toast on the screen. Can be tweaked further\nusing the `positionAnchor` property."
                 },
-                "attribute": "position",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'bottom'"
             },
             "positionAnchor": {
                 "type": "string",
+                "attribute": "position-anchor",
                 "mutable": false,
                 "complexType": {
                     "original": "HTMLElement | string",
@@ -701,11 +756,13 @@ export class Toast {
                     "tags": [],
                     "text": "The element to anchor the toast's position to. Can be set as a direct reference\nor the ID of the element. With `position=\"bottom\"`, the toast will sit above the\nchosen element. With `position=\"top\"`, the toast will sit below the chosen element.\nWith `position=\"middle\"`, the value of `positionAnchor` is ignored."
                 },
-                "attribute": "position-anchor",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "buttons": {
                 "type": "unknown",
+                "attribute": "buttons",
                 "mutable": false,
                 "complexType": {
                     "original": "(ToastButton | string)[]",
@@ -723,10 +780,13 @@ export class Toast {
                 "docs": {
                     "tags": [],
                     "text": "An array of buttons for the toast."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "translucent": {
                 "type": "boolean",
+                "attribute": "translucent",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -739,12 +799,14 @@ export class Toast {
                     "tags": [],
                     "text": "If `true`, the toast will be translucent.\nOnly applies when the mode is `\"ios\"` and the device supports\n[`backdrop-filter`](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter#Browser_compatibility)."
                 },
-                "attribute": "translucent",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "animated": {
                 "type": "boolean",
+                "attribute": "animated",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -757,12 +819,14 @@ export class Toast {
                     "tags": [],
                     "text": "If `true`, the toast will animate."
                 },
-                "attribute": "animated",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "icon": {
                 "type": "string",
+                "attribute": "icon",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -775,11 +839,13 @@ export class Toast {
                     "tags": [],
                     "text": "The name of the icon to display, or the path to a valid SVG file. See `ion-icon`.\nhttps://ionic.io/ionicons"
                 },
-                "attribute": "icon",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "htmlAttributes": {
                 "type": "unknown",
+                "attribute": "html-attributes",
                 "mutable": false,
                 "complexType": {
                     "original": "{ [key: string]: any }",
@@ -791,10 +857,13 @@ export class Toast {
                 "docs": {
                     "tags": [],
                     "text": "Additional attributes to pass to the toast."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "swipeGesture": {
                 "type": "string",
+                "attribute": "swipe-gesture",
                 "mutable": false,
                 "complexType": {
                     "original": "ToastSwipeGestureDirection",
@@ -813,11 +882,13 @@ export class Toast {
                     "tags": [],
                     "text": "If set to 'vertical', the Toast can be dismissed with\na swipe gesture. The swipe direction is determined by\nthe value of the `position` property:\n`top`: The Toast can be swiped up to dismiss.\n`bottom`: The Toast can be swiped down to dismiss.\n`middle`: The Toast can be swiped up or down to dismiss."
                 },
-                "attribute": "swipe-gesture",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "isOpen": {
                 "type": "boolean",
+                "attribute": "is-open",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -830,12 +901,14 @@ export class Toast {
                     "tags": [],
                     "text": "If `true`, the toast will open. If `false`, the toast will close.\nUse this if you need finer grained control over presentation, otherwise\njust use the toastController or the `trigger` property.\nNote: `isOpen` will not automatically be set back to `false` when\nthe toast 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",
@@ -848,7 +921,8 @@ export class Toast {
                     "tags": [],
                     "text": "An ID corresponding to the trigger element that\ncauses the toast to open when clicked."
                 },
-                "attribute": "trigger",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             }
         };

package/dist/collection/components/toggle/toggle.js

@@ -29,6 +29,45 @@ export class Toggle {
         this.lastDrag = 0;
         this.inheritedAttributes = {};
         this.didLoad = false;
+        this.activated = false;
+        /**
+         * The name of the control, which is submitted with the form data.
+         */
+        this.name = this.inputId;
+        /**
+         * If `true`, the toggle is selected.
+         */
+        this.checked = false;
+        /**
+         * If `true`, the user cannot interact with the toggle.
+         */
+        this.disabled = false;
+        /**
+         * The value of the toggle does not mean if it's checked or not, use the `checked`
+         * property for that.
+         *
+         * The value of a toggle is analogous to the value of a `<input type="checkbox">`,
+         * it's only used when the toggle participates in a native `<form>`.
+         */
+        this.value = 'on';
+        /**
+         * Enables the on/off accessibility switch labels within the toggle.
+         */
+        this.enableOnOffLabels = config.get('toggleOnOffLabels');
+        /**
+         * Where to place the label relative to the input.
+         * `"start"`: The label will appear to the left of the toggle in LTR and to the right in RTL.
+         * `"end"`: The label will appear to the right of the toggle in LTR and to the left in RTL.
+         * `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("...").
+         * `"stacked"`: The label will appear above the toggle regardless of the direction. The alignment of the label can be controlled with the `alignment` property.
+         */
+        this.labelPlacement = 'start';
+        /**
+         * If true, screen readers will announce it as a required field. This property
+         * works only for accessibility purposes, it will not prevent the form from
+         * submitting if the value is invalid.
+         */
+        this.required = false;
         this.setupGesture = async () => {
             const { toggleTrack } = this;
             if (toggleTrack) {
@@ -66,19 +105,6 @@ export class Toggle {
             }
             return checked ? removeOutline : ellipseOutline;
         };
-        this.activated = false;
-        this.color = undefined;
-        this.name = this.inputId;
-        this.checked = false;
-        this.disabled = false;
-        this.errorText = undefined;
-        this.helperText = undefined;
-        this.value = 'on';
-        this.enableOnOffLabels = config.get('toggleOnOffLabels');
-        this.labelPlacement = 'start';
-        this.justify = undefined;
-        this.alignment = undefined;
-        this.required = false;
     }
     disabledChanged() {
         if (this.gesture) {
@@ -225,6 +251,7 @@ export class Toggle {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -243,11 +270,13 @@ export class Toggle {
                     "tags": [],
                     "text": "The color to use from your application's color palette.\nDefault options are: `\"primary\"`, `\"secondary\"`, `\"tertiary\"`, `\"success\"`, `\"warning\"`, `\"danger\"`, `\"light\"`, `\"medium\"`, and `\"dark\"`.\nFor more information on colors, see [theming](/docs/theming/basics)."
                 },
-                "attribute": "color",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "name": {
                 "type": "string",
+                "attribute": "name",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -260,12 +289,14 @@ export class Toggle {
                     "tags": [],
                     "text": "The name of the control, which is submitted with the form data."
                 },
-                "attribute": "name",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "this.inputId"
             },
             "checked": {
                 "type": "boolean",
+                "attribute": "checked",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -278,12 +309,14 @@ export class Toggle {
                     "tags": [],
                     "text": "If `true`, the toggle is selected."
                 },
-                "attribute": "checked",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -296,12 +329,14 @@ export class Toggle {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the toggle."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "errorText": {
                 "type": "string",
+                "attribute": "error-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -314,11 +349,13 @@ export class Toggle {
                     "tags": [],
                     "text": "Text that is placed under the toggle label and displayed when an error is detected."
                 },
-                "attribute": "error-text",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "helperText": {
                 "type": "string",
+                "attribute": "helper-text",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -331,11 +368,13 @@ export class Toggle {
                     "tags": [],
                     "text": "Text that is placed under the toggle label and displayed when no error is detected."
                 },
-                "attribute": "helper-text",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "value": {
                 "type": "string",
+                "attribute": "value",
                 "mutable": false,
                 "complexType": {
                     "original": "string | null",
@@ -348,12 +387,14 @@ export class Toggle {
                     "tags": [],
                     "text": "The value of the toggle does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a toggle is analogous to the value of a `<input type=\"checkbox\">`,\nit's only used when the toggle participates in a native `<form>`."
                 },
-                "attribute": "value",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'on'"
             },
             "enableOnOffLabels": {
                 "type": "boolean",
+                "attribute": "enable-on-off-labels",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | undefined",
@@ -366,12 +407,14 @@ export class Toggle {
                     "tags": [],
                     "text": "Enables the on/off accessibility switch labels within the toggle."
                 },
-                "attribute": "enable-on-off-labels",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "config.get('toggleOnOffLabels')"
             },
             "labelPlacement": {
                 "type": "string",
+                "attribute": "label-placement",
                 "mutable": false,
                 "complexType": {
                     "original": "'start' | 'end' | 'fixed' | 'stacked'",
@@ -384,12 +427,14 @@ export class Toggle {
                     "tags": [],
                     "text": "Where to place the label relative to the input.\n`\"start\"`: The label will appear to the left of the toggle in LTR and to the right in RTL.\n`\"end\"`: The label will appear to the right of the toggle in LTR and to the left in RTL.\n`\"fixed\"`: The label has the same behavior as `\"start\"` except it also has a fixed width. Long text will be truncated with ellipses (\"...\").\n`\"stacked\"`: The label will appear above the toggle regardless of the direction. The alignment of the label can be controlled with the `alignment` property."
                 },
-                "attribute": "label-placement",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'start'"
             },
             "justify": {
                 "type": "string",
+                "attribute": "justify",
                 "mutable": false,
                 "complexType": {
                     "original": "'start' | 'end' | 'space-between'",
@@ -402,11 +447,13 @@ export class Toggle {
                     "tags": [],
                     "text": "How to pack the label and toggle within a line.\n`\"start\"`: The label and toggle will appear on the left in LTR and\non the right in RTL.\n`\"end\"`: The label and toggle will appear on the right in LTR and\non the left in RTL.\n`\"space-between\"`: The label and toggle will appear on opposite\nends of the line with space between the two elements.\nSetting this property will change the toggle `display` to `block`."
                 },
-                "attribute": "justify",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "alignment": {
                 "type": "string",
+                "attribute": "alignment",
                 "mutable": false,
                 "complexType": {
                     "original": "'start' | 'center'",
@@ -419,11 +466,13 @@ export class Toggle {
                     "tags": [],
                     "text": "How to control the alignment of the toggle and label on the cross axis.\n`\"start\"`: The label and control will appear on the left of the cross axis in LTR, and on the right side in RTL.\n`\"center\"`: The label and control will appear at the center of the cross axis in both LTR and RTL.\nSetting this property will change the toggle `display` to `block`."
                 },
-                "attribute": "alignment",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "required": {
                 "type": "boolean",
+                "attribute": "required",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -436,7 +485,8 @@ export class Toggle {
                     "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",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             }