@ionic/core 8.5.4-dev.11744406052.1d9f8ea6 → 8.5.4-dev.11744646756.1244bf71

package/dist/collection/components/input-password-toggle/input-password-toggle.js

@@ -11,6 +11,10 @@ import { getIonMode } from "../../global/ionic-global";
  */
 export class InputPasswordToggle {
     constructor() {
+        /**
+         * @internal
+         */
+        this.type = 'password';
         this.togglePasswordVisibility = () => {
             const { inputElRef } = this;
             if (!inputElRef) {
@@ -18,10 +22,6 @@ export class InputPasswordToggle {
             }
             inputElRef.type = inputElRef.type === 'text' ? 'password' : 'text';
         };
-        this.color = undefined;
-        this.showIcon = undefined;
-        this.hideIcon = undefined;
-        this.type = 'password';
     }
     /**
      * Whenever the input type changes we need to re-run validation to ensure the password
@@ -89,6 +89,7 @@ export class InputPasswordToggle {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -107,11 +108,13 @@ export class InputPasswordToggle {
                     "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
             },
             "showIcon": {
                 "type": "string",
+                "attribute": "show-icon",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -124,11 +127,13 @@ export class InputPasswordToggle {
                     "tags": [],
                     "text": "The icon that can be used to represent showing a password. If not set, the \"eye\" Ionicon will be used."
                 },
-                "attribute": "show-icon",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "hideIcon": {
                 "type": "string",
+                "attribute": "hide-icon",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -141,11 +146,13 @@ export class InputPasswordToggle {
                     "tags": [],
                     "text": "The icon that can be used to represent hiding a password. If not set, the \"eyeOff\" Ionicon will be used."
                 },
-                "attribute": "hide-icon",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": true,
                 "complexType": {
                     "original": "TextFieldTypes",
@@ -167,7 +174,8 @@ export class InputPasswordToggle {
                         }],
                     "text": ""
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'password'"
             }

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

@@ -23,18 +23,26 @@ export class Item {
         this.inheritedAriaAttributes = {};
         this.multipleInputs = false;
         this.focusable = true;
-        this.color = undefined;
+        /**
+         * If `true`, a button tag will be rendered and the item will be tappable.
+         */
         this.button = false;
-        this.detail = undefined;
+        /**
+         * The icon to use when `detail` is set to `true`.
+         */
         this.detailIcon = chevronForward;
+        /**
+         * If `true`, the user cannot interact with the item.
+         */
         this.disabled = false;
-        this.download = undefined;
-        this.href = undefined;
-        this.rel = undefined;
-        this.lines = undefined;
-        this.routerAnimation = undefined;
+        /**
+         * When using a router, it specifies the transition direction when navigating to
+         * another page using `href`.
+         */
         this.routerDirection = 'forward';
-        this.target = undefined;
+        /**
+         * The type of the button. Only used when an `onclick` or `button` property is present.
+         */
         this.type = 'button';
     }
     buttonChanged() {
@@ -234,6 +242,7 @@ export class Item {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -252,11 +261,13 @@ export class Item {
                     "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
             },
             "button": {
                 "type": "boolean",
+                "attribute": "button",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -269,12 +280,14 @@ export class Item {
                     "tags": [],
                     "text": "If `true`, a button tag will be rendered and the item will be tappable."
                 },
-                "attribute": "button",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "detail": {
                 "type": "boolean",
+                "attribute": "detail",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -287,11 +300,13 @@ export class Item {
                     "tags": [],
                     "text": "If `true`, a detail arrow will appear on the item. Defaults to `false` unless the `mode`\nis `ios` and an `href` or `button` property is present."
                 },
-                "attribute": "detail",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "detailIcon": {
                 "type": "string",
+                "attribute": "detail-icon",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -304,12 +319,14 @@ export class Item {
                     "tags": [],
                     "text": "The icon to use when `detail` is set to `true`."
                 },
-                "attribute": "detail-icon",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "chevronForward"
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -322,12 +339,14 @@ export class Item {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the item."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "false"
             },
             "download": {
                 "type": "string",
+                "attribute": "download",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -340,11 +359,13 @@ export class Item {
                     "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)."
                 },
-                "attribute": "download",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "href": {
                 "type": "string",
+                "attribute": "href",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -357,11 +378,13 @@ export class Item {
                     "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."
                 },
-                "attribute": "href",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "rel": {
                 "type": "string",
+                "attribute": "rel",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -374,11 +397,13 @@ export class Item {
                     "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)."
                 },
-                "attribute": "rel",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "lines": {
                 "type": "string",
+                "attribute": "lines",
                 "mutable": false,
                 "complexType": {
                     "original": "'full' | 'inset' | 'none'",
@@ -391,11 +416,13 @@ export class Item {
                     "tags": [],
                     "text": "How the bottom border should be displayed on the item."
                 },
-                "attribute": "lines",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "routerAnimation": {
                 "type": "unknown",
+                "attribute": "router-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder | undefined",
@@ -413,10 +440,13 @@ export class Item {
                 "docs": {
                     "tags": [],
                     "text": "When using a router, it specifies the transition animation when navigating to\nanother page using `href`."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "routerDirection": {
                 "type": "string",
+                "attribute": "router-direction",
                 "mutable": false,
                 "complexType": {
                     "original": "RouterDirection",
@@ -435,12 +465,14 @@ export class Item {
                     "tags": [],
                     "text": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`."
                 },
-                "attribute": "router-direction",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'forward'"
             },
             "target": {
                 "type": "string",
+                "attribute": "target",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -453,11 +485,13 @@ export class Item {
                     "tags": [],
                     "text": "Specifies where to display the linked URL.\nOnly applies when an `href` is provided.\nSpecial keywords: `\"_blank\"`, `\"_self\"`, `\"_parent\"`, `\"_top\"`."
                 },
-                "attribute": "target",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": false,
                 "complexType": {
                     "original": "'submit' | 'reset' | 'button'",
@@ -470,7 +504,8 @@ export class Item {
                     "tags": [],
                     "text": "The type of the button. Only used when an `onclick` or `button` property is present."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'button'"
             }

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

@@ -13,7 +13,13 @@ import { getIonMode } from "../../global/ionic-global";
  */
 export class ItemDivider {
     constructor() {
-        this.color = undefined;
+        /**
+         * When it's set to `true`, the item-divider will stay visible when it reaches the top
+         * of the viewport until the next `ion-item-divider` replaces it.
+         *
+         * This feature relies in `position:sticky`:
+         * https://caniuse.com/#feat=css-sticky
+         */
         this.sticky = false;
     }
     render() {
@@ -42,6 +48,7 @@ export class ItemDivider {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -60,11 +67,13 @@ export class ItemDivider {
                     "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
             },
             "sticky": {
                 "type": "boolean",
+                "attribute": "sticky",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -77,7 +86,8 @@ export class ItemDivider {
                     "tags": [],
                     "text": "When it's set to `true`, the item-divider will stay visible when it reaches the top\nof the viewport until the next `ion-item-divider` replaces it.\n\nThis feature relies in `position:sticky`:\nhttps://caniuse.com/#feat=css-sticky"
                 },
-                "attribute": "sticky",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             }

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;
@@ -69,6 +73,7 @@ export class ItemOption {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -87,11 +92,13 @@ 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)."
                 },
-                "attribute": "color",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -104,12 +111,14 @@ export class ItemOption {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the item option."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "download": {
                 "type": "string",
+                "attribute": "download",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -122,11 +131,13 @@ 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)."
                 },
-                "attribute": "download",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "expandable": {
                 "type": "boolean",
+                "attribute": "expandable",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -139,12 +150,14 @@ export class ItemOption {
                     "tags": [],
                     "text": "If `true`, the option will expand to take up the available width and cover any other options."
                 },
-                "attribute": "expandable",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "href": {
                 "type": "string",
+                "attribute": "href",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -157,11 +170,13 @@ 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."
                 },
-                "attribute": "href",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "rel": {
                 "type": "string",
+                "attribute": "rel",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -174,11 +189,13 @@ 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)."
                 },
-                "attribute": "rel",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "target": {
                 "type": "string",
+                "attribute": "target",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -191,11 +208,13 @@ 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\"`."
                 },
-                "attribute": "target",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "type": {
                 "type": "string",
+                "attribute": "type",
                 "mutable": false,
                 "complexType": {
                     "original": "'submit' | 'reset' | 'button'",
@@ -208,7 +227,8 @@ export class ItemOption {
                     "tags": [],
                     "text": "The type of the button."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "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 */
@@ -50,6 +54,7 @@ export class ItemOptions {
         return {
             "side": {
                 "type": "string",
+                "attribute": "side",
                 "mutable": false,
                 "complexType": {
                     "original": "Side",
@@ -68,7 +73,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."
                 },
-                "attribute": "side",
+                "getter": false,
+                "setter": false,
                 "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() {
@@ -410,6 +413,7 @@ export class ItemSliding {
         return {
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -422,7 +426,8 @@ export class ItemSliding {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the sliding item."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "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() {
@@ -81,6 +79,7 @@ export class Label {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -99,11 +98,13 @@ 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)."
                 },
-                "attribute": "color",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "position": {
                 "type": "string",
+                "attribute": "position",
                 "mutable": false,
                 "complexType": {
                     "original": "'fixed' | 'stacked' | 'floating'",
@@ -116,7 +117,8 @@ export class Label {
                     "tags": [],
                     "text": "The position determines where and how the label behaves inside an item."
                 },
-                "attribute": "position",
+                "getter": false,
+                "setter": false,
                 "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;
     }
     /**
@@ -53,6 +55,7 @@ export class List {
         return {
             "lines": {
                 "type": "string",
+                "attribute": "lines",
                 "mutable": false,
                 "complexType": {
                     "original": "'full' | 'inset' | 'none'",
@@ -65,11 +68,13 @@ export class List {
                     "tags": [],
                     "text": "How the bottom border should be displayed on all items."
                 },
-                "attribute": "lines",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "inset": {
                 "type": "boolean",
+                "attribute": "inset",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -82,7 +87,8 @@ export class List {
                     "tags": [],
                     "text": "If `true`, the list will have margin around it and rounded corners."
                 },
-                "attribute": "inset",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             }