@ionic/core 8.5.4-dev.11743804857.1f3f3ee1 → 8.5.4-dev.11743808789.130d15f2

package/dist/collection/components/list-header/list-header.js

@@ -8,10 +8,6 @@ import { getIonMode } from "../../global/ionic-global";
  * @virtualProp {"ios" | "md"} mode - The mode determines which platform styles to use.
  */
 export class ListHeader {
-    constructor() {
-        this.color = undefined;
-        this.lines = undefined;
-    }
     render() {
         const { lines } = this;
         const mode = getIonMode(this);
@@ -38,6 +34,7 @@ export class ListHeader {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -56,11 +53,13 @@ export class ListHeader {
                     "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
             },
             "lines": {
                 "type": "string",
+                "attribute": "lines",
                 "mutable": false,
                 "complexType": {
                     "original": "'full' | 'inset' | 'none'",
@@ -73,7 +72,8 @@ export class ListHeader {
                     "tags": [],
                     "text": "How the bottom border should be displayed on the list header."
                 },
-                "attribute": "lines",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             }
         };

package/dist/collection/components/loading/loading.js

@@ -25,26 +25,45 @@ export class Loading {
         this.triggerController = createTriggerController();
         this.customHTMLEnabled = config.get('innerHTMLTemplatesEnabled', ENABLE_HTML_CONTENT_DEFAULT);
         this.presented = false;
-        this.onBackdropTap = () => {
-            this.dismiss(undefined, BACKDROP);
-        };
-        this.overlayIndex = undefined;
-        this.delegate = undefined;
+        /** @internal */
         this.hasController = false;
+        /**
+         * If `true`, the keyboard will be automatically dismissed when the overlay is presented.
+         */
         this.keyboardClose = true;
-        this.enterAnimation = undefined;
-        this.leaveAnimation = undefined;
-        this.message = undefined;
-        this.cssClass = undefined;
+        /**
+         * Number of milliseconds to wait before dismissing the loading indicator.
+         */
         this.duration = 0;
+        /**
+         * If `true`, the loading indicator will be dismissed when the backdrop is clicked.
+         */
         this.backdropDismiss = false;
+        /**
+         * If `true`, a backdrop will be displayed behind the loading indicator.
+         */
         this.showBackdrop = true;
-        this.spinner = undefined;
+        /**
+         * If `true`, the loading indicator 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 loading indicator will animate.
+         */
         this.animated = true;
-        this.htmlAttributes = undefined;
+        /**
+         * If `true`, the loading indicator will open. If `false`, the loading indicator will close.
+         * Use this if you need finer grained control over presentation, otherwise
+         * just use the loadingController or the `trigger` property.
+         * Note: `isOpen` will not automatically be set back to `false` when
+         * the loading indicator dismisses. You will need to do that in your code.
+         */
         this.isOpen = false;
-        this.trigger = undefined;
+        this.onBackdropTap = () => {
+            this.dismiss(undefined, BACKDROP);
+        };
     }
     onIsOpenChange(newValue, oldValue) {
         if (newValue === true && oldValue === false) {
@@ -183,6 +202,7 @@ export class Loading {
         return {
             "overlayIndex": {
                 "type": "number",
+                "attribute": "overlay-index",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -198,11 +218,13 @@ export class Loading {
                         }],
                     "text": ""
                 },
-                "attribute": "overlay-index",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "delegate": {
                 "type": "unknown",
+                "attribute": "delegate",
                 "mutable": false,
                 "complexType": {
                     "original": "FrameworkDelegate",
@@ -223,10 +245,13 @@ export class Loading {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "hasController": {
                 "type": "boolean",
+                "attribute": "has-controller",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -242,12 +267,14 @@ export class Loading {
                         }],
                     "text": ""
                 },
-                "attribute": "has-controller",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "keyboardClose": {
                 "type": "boolean",
+                "attribute": "keyboard-close",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -260,12 +287,14 @@ export class Loading {
                     "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": "true"
             },
             "enterAnimation": {
                 "type": "unknown",
+                "attribute": "enter-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -283,10 +312,13 @@ export class Loading {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the loading indicator is presented."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "leaveAnimation": {
                 "type": "unknown",
+                "attribute": "leave-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -304,10 +336,13 @@ export class Loading {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the loading indicator is dismissed."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "message": {
                 "type": "string",
+                "attribute": "message",
                 "mutable": false,
                 "complexType": {
                     "original": "string | IonicSafeString",
@@ -326,11 +361,13 @@ export class Loading {
                     "tags": [],
                     "text": "Optional text content to display in the loading indicator.\n\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
             },
             "cssClass": {
                 "type": "string",
+                "attribute": "css-class",
                 "mutable": false,
                 "complexType": {
                     "original": "string | string[]",
@@ -343,11 +380,13 @@ export class Loading {
                     "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",
@@ -360,12 +399,14 @@ export class Loading {
                     "tags": [],
                     "text": "Number of milliseconds to wait before dismissing the loading indicator."
                 },
-                "attribute": "duration",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "0"
             },
             "backdropDismiss": {
                 "type": "boolean",
+                "attribute": "backdrop-dismiss",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -378,12 +419,14 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, the loading indicator will be dismissed when the backdrop is clicked."
                 },
-                "attribute": "backdrop-dismiss",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "showBackdrop": {
                 "type": "boolean",
+                "attribute": "show-backdrop",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -396,12 +439,14 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, a backdrop will be displayed behind the loading indicator."
                 },
-                "attribute": "show-backdrop",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "spinner": {
                 "type": "string",
+                "attribute": "spinner",
                 "mutable": true,
                 "complexType": {
                     "original": "SpinnerTypes | null",
@@ -420,11 +465,13 @@ export class Loading {
                     "tags": [],
                     "text": "The name of the spinner to display."
                 },
-                "attribute": "spinner",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "translucent": {
                 "type": "boolean",
+                "attribute": "translucent",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -437,12 +484,14 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, the loading indicator 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",
@@ -455,12 +504,14 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, the loading indicator will animate."
                 },
-                "attribute": "animated",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "htmlAttributes": {
                 "type": "unknown",
+                "attribute": "html-attributes",
                 "mutable": false,
                 "complexType": {
                     "original": "{ [key: string]: any }",
@@ -472,10 +523,13 @@ export class Loading {
                 "docs": {
                     "tags": [],
                     "text": "Additional attributes to pass to the loader."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "isOpen": {
                 "type": "boolean",
+                "attribute": "is-open",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -488,12 +542,14 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, the loading indicator will open. If `false`, the loading indicator will close.\nUse this if you need finer grained control over presentation, otherwise\njust use the loadingController or the `trigger` property.\nNote: `isOpen` will not automatically be set back to `false` when\nthe loading indicator 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",
@@ -506,7 +562,8 @@ export class Loading {
                     "tags": [],
                     "text": "An ID corresponding to the trigger element that\ncauses the loading indicator to open when clicked."
                 },
-                "attribute": "trigger",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             }
         };

package/dist/collection/components/menu/menu.js

@@ -51,14 +51,32 @@ export class Menu {
             }
             this.trapKeyboardFocus(ev, document);
         };
+        /**
+         * If true, then the menu should be
+         * visible within a split pane.
+         * If false, then the menu is hidden.
+         * However, the menu-button/menu-toggle
+         * components can be used to open the
+         * menu.
+         */
         this.isPaneVisible = false;
         this.isEndSide = false;
-        this.contentId = undefined;
-        this.menuId = undefined;
-        this.type = undefined;
+        /**
+         * If `true`, the menu is disabled.
+         */
         this.disabled = false;
+        /**
+         * Which side of the view the menu should be placed.
+         */
         this.side = 'start';
+        /**
+         * If `true`, swiping the menu is enabled.
+         */
         this.swipeGesture = true;
+        /**
+         * The edge threshold for dragging the menu open.
+         * If a drag/swipe happens over this value, the menu is not triggered.
+         */
         this.maxEdgeStart = 50;
     }
     typeChanged(type, oldType) {
@@ -641,6 +659,7 @@ export class Menu {
         return {
             "contentId": {
                 "type": "string",
+                "attribute": "content-id",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -653,11 +672,13 @@ export class Menu {
                     "tags": [],
                     "text": "The `id` of the main content. When using\na router this is typically `ion-router-outlet`.\nWhen not using a router, this is typically\nyour main view's `ion-content`. This is not the\nid of the `ion-content` inside of your `ion-menu`."
                 },
-                "attribute": "content-id",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "menuId": {
                 "type": "string",
+                "attribute": "menu-id",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -670,11 +691,13 @@ export class Menu {
                     "tags": [],
                     "text": "An id for the menu."
                 },
-                "attribute": "menu-id",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": true,
                 "complexType": {
                     "original": "MenuType",
@@ -693,11 +716,13 @@ export class Menu {
                     "tags": [],
                     "text": "The display type of the menu.\nAvailable options: `\"overlay\"`, `\"reveal\"`, `\"push\"`."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -710,12 +735,14 @@ export class Menu {
                     "tags": [],
                     "text": "If `true`, the menu is disabled."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "side": {
                 "type": "string",
+                "attribute": "side",
                 "mutable": false,
                 "complexType": {
                     "original": "Side",
@@ -734,12 +761,14 @@ export class Menu {
                     "tags": [],
                     "text": "Which side of the view the menu should be placed."
                 },
-                "attribute": "side",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "'start'"
             },
             "swipeGesture": {
                 "type": "boolean",
+                "attribute": "swipe-gesture",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -752,12 +781,14 @@ export class Menu {
                     "tags": [],
                     "text": "If `true`, swiping the menu is enabled."
                 },
-                "attribute": "swipe-gesture",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "maxEdgeStart": {
                 "type": "number",
+                "attribute": "max-edge-start",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -770,7 +801,8 @@ export class Menu {
                     "tags": [],
                     "text": "The edge threshold for dragging the menu open.\nIf a drag/swipe happens over this value, the menu is not triggered."
                 },
-                "attribute": "max-edge-start",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "50"
             }

package/dist/collection/components/menu-button/menu-button.js

@@ -18,15 +18,22 @@ import { updateVisibility } from "../menu-toggle/menu-toggle-util";
 export class MenuButton {
     constructor() {
         this.inheritedAttributes = {};
-        this.onClick = async () => {
-            return menuController.toggle(this.menu);
-        };
         this.visible = false;
-        this.color = undefined;
+        /**
+         * If `true`, the user cannot interact with the menu button.
+         */
         this.disabled = false;
-        this.menu = undefined;
+        /**
+         * Automatically hides the menu button when the corresponding menu is not active
+         */
         this.autoHide = true;
+        /**
+         * The type of the button.
+         */
         this.type = 'button';
+        this.onClick = async () => {
+            return menuController.toggle(this.menu);
+        };
     }
     componentWillLoad() {
         this.inheritedAttributes = inheritAriaAttributes(this.el);
@@ -75,6 +82,7 @@ export class MenuButton {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -93,11 +101,13 @@ export class MenuButton {
                     "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
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -110,12 +120,14 @@ export class MenuButton {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the menu button."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "menu": {
                 "type": "string",
+                "attribute": "menu",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -128,11 +140,13 @@ export class MenuButton {
                     "tags": [],
                     "text": "Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle"
                 },
-                "attribute": "menu",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "autoHide": {
                 "type": "boolean",
+                "attribute": "auto-hide",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -145,12 +159,14 @@ export class MenuButton {
                     "tags": [],
                     "text": "Automatically hides the menu button when the corresponding menu is not active"
                 },
-                "attribute": "auto-hide",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": false,
                 "complexType": {
                     "original": "'submit' | 'reset' | 'button'",
@@ -163,7 +179,8 @@ export class MenuButton {
                     "tags": [],
                     "text": "The type of the button."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'button'"
             }

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

@@ -10,12 +10,17 @@ import { updateVisibility } from "./menu-toggle-util";
  */
 export class MenuToggle {
     constructor() {
+        this.visible = false;
+        /**
+         * Automatically hides the content when the corresponding menu is not active.
+         *
+         * By default, it's `true`. Change it to `false` in order to
+         * keep `ion-menu-toggle` always visible regardless the state of the menu.
+         */
+        this.autoHide = true;
         this.onClick = () => {
             return menuController.toggle(this.menu);
         };
-        this.visible = false;
-        this.menu = undefined;
-        this.autoHide = true;
     }
     connectedCallback() {
         this.visibilityChanged();
@@ -47,6 +52,7 @@ export class MenuToggle {
         return {
             "menu": {
                 "type": "string",
+                "attribute": "menu",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -59,11 +65,13 @@ export class MenuToggle {
                     "tags": [],
                     "text": "Optional property that maps to a Menu's `menuId` prop.\nCan also be `start` or `end` for the menu side.\nThis is used to find the correct menu to toggle.\n\nIf this property is not used, `ion-menu-toggle` will toggle the\nfirst menu that is active."
                 },
-                "attribute": "menu",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "autoHide": {
                 "type": "boolean",
+                "attribute": "auto-hide",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -76,7 +84,8 @@ export class MenuToggle {
                     "tags": [],
                     "text": "Automatically hides the content when the corresponding menu is not active.\n\nBy default, it's `true`. Change it to `false` in order to\nkeep `ion-menu-toggle` always visible regardless the state of the menu."
                 },
-                "attribute": "auto-hide",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             }