@ionic/core 8.4.2-dev.11736277041.14f34ba1 → 8.4.2-dev.11736797843.16cc5058

package/dist/collection/components/item-option/item-option.js

@@ -18,20 +18,24 @@ import { getIonMode } from "../../global/ionic-global";
  */
 export class ItemOption {
     constructor() {
+        /**
+         * If `true`, the user cannot interact with the item option.
+         */
+        this.disabled = false;
+        /**
+         * If `true`, the option will expand to take up the available width and cover any other options.
+         */
+        this.expandable = false;
+        /**
+         * The type of the button.
+         */
+        this.type = 'button';
         this.onClick = (ev) => {
             const el = ev.target.closest('ion-item-option');
             if (el) {
                 ev.preventDefault();
             }
         };
-        this.color = undefined;
-        this.disabled = false;
-        this.download = undefined;
-        this.expandable = false;
-        this.href = undefined;
-        this.rel = undefined;
-        this.target = undefined;
-        this.type = 'button';
     }
     render() {
         const { disabled, expandable, href } = this;
@@ -87,6 +91,8 @@ export class ItemOption {
                     "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)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "color",
                 "reflect": true
             },
@@ -104,6 +110,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the item option."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "disabled",
                 "reflect": false,
                 "defaultValue": "false"
@@ -122,6 +130,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "This attribute instructs browsers to download a URL instead of navigating to\nit, so the user will be prompted to save it as a local file. If the attribute\nhas a value, it is used as the pre-filled file name in the Save prompt\n(the user can still change the file name if they want)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "download",
                 "reflect": false
             },
@@ -139,6 +149,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "If `true`, the option will expand to take up the available width and cover any other options."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "expandable",
                 "reflect": false,
                 "defaultValue": "false"
@@ -157,6 +169,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "Contains a URL or a URL fragment that the hyperlink points to.\nIf this property is set, an anchor tag will be rendered."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "href",
                 "reflect": false
             },
@@ -174,6 +188,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "Specifies the relationship of the target object to the link object.\nThe value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "rel",
                 "reflect": false
             },
@@ -191,6 +207,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "target",
                 "reflect": false
             },
@@ -208,6 +226,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "The type of the button."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "type",
                 "reflect": false,
                 "defaultValue": "'button'"

package/dist/collection/components/item-options/item-options.js

@@ -6,6 +6,10 @@ import { isEndSide } from "../../utils/helpers";
 import { getIonMode } from "../../global/ionic-global";
 export class ItemOptions {
     constructor() {
+        /**
+         * The side the option button should be on. Possible values: `"start"` and `"end"`. If you have multiple `ion-item-options`, a side must be provided for each.
+         *
+         */
         this.side = 'end';
     }
     /** @internal */
@@ -68,6 +72,8 @@ export class ItemOptions {
                     "tags": [],
                     "text": "The side the option button should be on. Possible values: `\"start\"` and `\"end\"`. If you have multiple `ion-item-options`, a side must be provided for each."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "side",
                 "reflect": false,
                 "defaultValue": "'end'"

package/dist/collection/components/item-sliding/item-sliding.js

@@ -21,6 +21,9 @@ export class ItemSliding {
         this.contentEl = null;
         this.initialContentScrollY = true;
         this.state = 2 /* SlidingState.Disabled */;
+        /**
+         * If `true`, the user cannot interact with the sliding item.
+         */
         this.disabled = false;
     }
     disabledChanged() {
@@ -422,6 +425,8 @@ export class ItemSliding {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the sliding item."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "disabled",
                 "reflect": false,
                 "defaultValue": "false"

package/dist/collection/components/label/label.js

@@ -10,8 +10,6 @@ import { getIonMode } from "../../global/ionic-global";
 export class Label {
     constructor() {
         this.inRange = false;
-        this.color = undefined;
-        this.position = undefined;
         this.noAnimate = false;
     }
     componentWillLoad() {
@@ -99,6 +97,8 @@ export class Label {
                     "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)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "color",
                 "reflect": true
             },
@@ -116,6 +116,8 @@ export class Label {
                     "tags": [],
                     "text": "The position determines where and how the label behaves inside an item."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "position",
                 "reflect": false
             }

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

@@ -8,7 +8,9 @@ import { getIonMode } from "../../global/ionic-global";
  */
 export class List {
     constructor() {
-        this.lines = undefined;
+        /**
+         * If `true`, the list will have margin around it and rounded corners.
+         */
         this.inset = false;
     }
     /**
@@ -65,6 +67,8 @@ export class List {
                     "tags": [],
                     "text": "How the bottom border should be displayed on all items."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "lines",
                 "reflect": false
             },
@@ -82,6 +86,8 @@ export class List {
                     "tags": [],
                     "text": "If `true`, the list will have margin around it and rounded corners."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "inset",
                 "reflect": false,
                 "defaultValue": "false"

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);
@@ -56,6 +52,8 @@ 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)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "color",
                 "reflect": true
             },
@@ -73,6 +71,8 @@ export class ListHeader {
                     "tags": [],
                     "text": "How the bottom border should be displayed on the list header."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "lines",
                 "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) {
@@ -198,6 +217,8 @@ export class Loading {
                         }],
                     "text": ""
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "overlay-index",
                 "reflect": false
             },
@@ -223,7 +244,9 @@ export class Loading {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "hasController": {
                 "type": "boolean",
@@ -242,6 +265,8 @@ export class Loading {
                         }],
                     "text": ""
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "has-controller",
                 "reflect": false,
                 "defaultValue": "false"
@@ -260,6 +285,8 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, the keyboard will be automatically dismissed when the overlay is presented."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "keyboard-close",
                 "reflect": false,
                 "defaultValue": "true"
@@ -283,7 +310,9 @@ export class Loading {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the loading indicator is presented."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "leaveAnimation": {
                 "type": "unknown",
@@ -304,7 +333,9 @@ export class Loading {
                 "docs": {
                     "tags": [],
                     "text": "Animation to use when the loading indicator is dismissed."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "message": {
                 "type": "string",
@@ -326,6 +357,8 @@ 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."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "message",
                 "reflect": false
             },
@@ -343,6 +376,8 @@ export class Loading {
                     "tags": [],
                     "text": "Additional classes to apply for custom CSS. If multiple classes are\nprovided they should be separated by spaces."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "css-class",
                 "reflect": false
             },
@@ -360,6 +395,8 @@ export class Loading {
                     "tags": [],
                     "text": "Number of milliseconds to wait before dismissing the loading indicator."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "duration",
                 "reflect": false,
                 "defaultValue": "0"
@@ -378,6 +415,8 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, the loading indicator will be dismissed when the backdrop is clicked."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "backdrop-dismiss",
                 "reflect": false,
                 "defaultValue": "false"
@@ -396,6 +435,8 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, a backdrop will be displayed behind the loading indicator."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "show-backdrop",
                 "reflect": false,
                 "defaultValue": "true"
@@ -420,6 +461,8 @@ export class Loading {
                     "tags": [],
                     "text": "The name of the spinner to display."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "spinner",
                 "reflect": false
             },
@@ -437,6 +480,8 @@ 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)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "translucent",
                 "reflect": false,
                 "defaultValue": "false"
@@ -455,6 +500,8 @@ export class Loading {
                     "tags": [],
                     "text": "If `true`, the loading indicator will animate."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "animated",
                 "reflect": false,
                 "defaultValue": "true"
@@ -472,7 +519,9 @@ export class Loading {
                 "docs": {
                     "tags": [],
                     "text": "Additional attributes to pass to the loader."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "isOpen": {
                 "type": "boolean",
@@ -488,6 +537,8 @@ 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."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "is-open",
                 "reflect": false,
                 "defaultValue": "false"
@@ -506,6 +557,8 @@ export class Loading {
                     "tags": [],
                     "text": "An ID corresponding to the trigger element that\ncauses the loading indicator to open when clicked."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "trigger",
                 "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) {
@@ -653,6 +671,8 @@ 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`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "content-id",
                 "reflect": true
             },
@@ -670,6 +690,8 @@ export class Menu {
                     "tags": [],
                     "text": "An id for the menu."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "menu-id",
                 "reflect": true
             },
@@ -693,6 +715,8 @@ export class Menu {
                     "tags": [],
                     "text": "The display type of the menu.\nAvailable options: `\"overlay\"`, `\"reveal\"`, `\"push\"`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "type",
                 "reflect": false
             },
@@ -710,6 +734,8 @@ export class Menu {
                     "tags": [],
                     "text": "If `true`, the menu is disabled."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "disabled",
                 "reflect": false,
                 "defaultValue": "false"
@@ -734,6 +760,8 @@ export class Menu {
                     "tags": [],
                     "text": "Which side of the view the menu should be placed."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "side",
                 "reflect": true,
                 "defaultValue": "'start'"
@@ -752,6 +780,8 @@ export class Menu {
                     "tags": [],
                     "text": "If `true`, swiping the menu is enabled."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "swipe-gesture",
                 "reflect": false,
                 "defaultValue": "true"
@@ -770,6 +800,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."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "max-edge-start",
                 "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);
@@ -93,6 +100,8 @@ 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)."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "color",
                 "reflect": true
             },
@@ -110,6 +119,8 @@ export class MenuButton {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the menu button."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "disabled",
                 "reflect": false,
                 "defaultValue": "false"
@@ -128,6 +139,8 @@ 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"
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "menu",
                 "reflect": false
             },
@@ -145,6 +158,8 @@ export class MenuButton {
                     "tags": [],
                     "text": "Automatically hides the menu button when the corresponding menu is not active"
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "auto-hide",
                 "reflect": false,
                 "defaultValue": "true"
@@ -163,6 +178,8 @@ export class MenuButton {
                     "tags": [],
                     "text": "The type of the button."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "type",
                 "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();
@@ -59,6 +64,8 @@ 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."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "menu",
                 "reflect": false
             },
@@ -76,6 +83,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."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "auto-hide",
                 "reflect": false,
                 "defaultValue": "true"