@ionic/core 8.5.9 → 8.6.0

package/dist/collection/components/breadcrumb/breadcrumb.js

@@ -16,6 +16,23 @@ import { getIonMode } from "../../global/ionic-global";
 export class Breadcrumb {
     constructor() {
         this.inheritedAttributes = {};
+        /** @internal */
+        this.collapsed = false;
+        /**
+         * If `true`, the breadcrumb will take on a different look to show that
+         * it is the currently active breadcrumb. Defaults to `true` for the
+         * last breadcrumb if it is not set on any.
+         */
+        this.active = false;
+        /**
+         * If `true`, the user cannot interact with the breadcrumb.
+         */
+        this.disabled = false;
+        /**
+         * When using a router, it specifies the transition direction when navigating to
+         * another page using `href`.
+         */
+        this.routerDirection = 'forward';
         this.onFocus = () => {
             this.ionFocus.emit();
         };
@@ -25,19 +42,6 @@ export class Breadcrumb {
         this.collapsedIndicatorClick = () => {
             this.collapsedClick.emit({ ionShadowTarget: this.collapsedRef });
         };
-        this.collapsed = false;
-        this.last = undefined;
-        this.showCollapsedIndicator = undefined;
-        this.color = undefined;
-        this.active = false;
-        this.disabled = false;
-        this.download = undefined;
-        this.href = undefined;
-        this.rel = undefined;
-        this.separator = undefined;
-        this.target = undefined;
-        this.routerDirection = 'forward';
-        this.routerAnimation = undefined;
     }
     componentWillLoad() {
         this.inheritedAttributes = inheritAriaAttributes(this.el);
@@ -102,6 +106,7 @@ export class Breadcrumb {
         return {
             "collapsed": {
                 "type": "boolean",
+                "attribute": "collapsed",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -117,12 +122,14 @@ export class Breadcrumb {
                         }],
                     "text": ""
                 },
-                "attribute": "collapsed",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "last": {
                 "type": "boolean",
+                "attribute": "last",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -138,11 +145,13 @@ export class Breadcrumb {
                         }],
                     "text": ""
                 },
-                "attribute": "last",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "showCollapsedIndicator": {
                 "type": "boolean",
+                "attribute": "show-collapsed-indicator",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -158,11 +167,13 @@ export class Breadcrumb {
                         }],
                     "text": ""
                 },
-                "attribute": "show-collapsed-indicator",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -181,11 +192,13 @@ export class Breadcrumb {
                     "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": false
             },
             "active": {
                 "type": "boolean",
+                "attribute": "active",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -198,12 +211,14 @@ export class Breadcrumb {
                     "tags": [],
                     "text": "If `true`, the breadcrumb will take on a different look to show that\nit is the currently active breadcrumb. Defaults to `true` for the\nlast breadcrumb if it is not set on any."
                 },
-                "attribute": "active",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -216,12 +231,14 @@ export class Breadcrumb {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the breadcrumb."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "download": {
                 "type": "string",
+                "attribute": "download",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -234,11 +251,13 @@ export class Breadcrumb {
                     "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",
@@ -251,11 +270,13 @@ export class Breadcrumb {
                     "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",
@@ -268,11 +289,13 @@ export class Breadcrumb {
                     "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
             },
             "separator": {
                 "type": "boolean",
+                "attribute": "separator",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean | undefined",
@@ -285,11 +308,13 @@ export class Breadcrumb {
                     "tags": [],
                     "text": "If true, show a separator between this breadcrumb and the next.\nDefaults to `true` for all breadcrumbs except the last."
                 },
-                "attribute": "separator",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "target": {
                 "type": "string",
+                "attribute": "target",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -302,11 +327,13 @@ export class Breadcrumb {
                     "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
             },
             "routerDirection": {
                 "type": "string",
+                "attribute": "router-direction",
                 "mutable": false,
                 "complexType": {
                     "original": "RouterDirection",
@@ -325,12 +352,14 @@ export class Breadcrumb {
                     "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'"
             },
             "routerAnimation": {
                 "type": "unknown",
+                "attribute": "router-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder | undefined",
@@ -348,7 +377,9 @@ export class Breadcrumb {
                 "docs": {
                     "tags": [],
                     "text": "When using a router, it specifies the transition animation when navigating to\nanother page using `href`."
-                }
+                },
+                "getter": false,
+                "setter": false
             }
         };
     }

package/dist/collection/components/breadcrumbs/breadcrumbs.js

@@ -10,6 +10,18 @@ import { getIonMode } from "../../global/ionic-global";
  */
 export class Breadcrumbs {
     constructor() {
+        /**
+         * The number of breadcrumbs to show before the collapsed indicator.
+         * If `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`,
+         * the breadcrumbs will not be collapsed.
+         */
+        this.itemsBeforeCollapse = 1;
+        /**
+         * The number of breadcrumbs to show after the collapsed indicator.
+         * If `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`,
+         * the breadcrumbs will not be collapsed.
+         */
+        this.itemsAfterCollapse = 1;
         this.breadcrumbsInit = () => {
             this.setBreadcrumbSeparator();
             this.setMaxItems();
@@ -83,12 +95,6 @@ export class Breadcrumbs {
             this.resetActiveBreadcrumb();
             this.breadcrumbsInit();
         };
-        this.collapsed = undefined;
-        this.activeChanged = undefined;
-        this.color = undefined;
-        this.maxItems = undefined;
-        this.itemsBeforeCollapse = 1;
-        this.itemsAfterCollapse = 1;
     }
     onCollapsedClick(ev) {
         const breadcrumbs = this.getBreadcrumbs();
@@ -130,6 +136,7 @@ export class Breadcrumbs {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -148,11 +155,13 @@ export class Breadcrumbs {
                     "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
             },
             "maxItems": {
                 "type": "number",
+                "attribute": "max-items",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -165,11 +174,13 @@ export class Breadcrumbs {
                     "tags": [],
                     "text": "The maximum number of breadcrumbs to show before collapsing."
                 },
-                "attribute": "max-items",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "itemsBeforeCollapse": {
                 "type": "number",
+                "attribute": "items-before-collapse",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -182,12 +193,14 @@ export class Breadcrumbs {
                     "tags": [],
                     "text": "The number of breadcrumbs to show before the collapsed indicator.\nIf `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`,\nthe breadcrumbs will not be collapsed."
                 },
-                "attribute": "items-before-collapse",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "1"
             },
             "itemsAfterCollapse": {
                 "type": "number",
+                "attribute": "items-after-collapse",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -200,7 +213,8 @@ export class Breadcrumbs {
                     "tags": [],
                     "text": "The number of breadcrumbs to show after the collapsed indicator.\nIf `itemsBeforeCollapse` + `itemsAfterCollapse` is greater than `maxItems`,\nthe breadcrumbs will not be collapsed."
                 },
-                "attribute": "items-after-collapse",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "1"
             }

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

@@ -24,6 +24,31 @@ export class Button {
         this.formButtonEl = null;
         this.formEl = null;
         this.inheritedAttributes = {};
+        /**
+         * If `true`, the button only has an icon.
+         */
+        this.isCircle = false;
+        /**
+         * The type of button.
+         */
+        this.buttonType = 'button';
+        /**
+         * If `true`, the user cannot interact with the button.
+         */
+        this.disabled = false;
+        /**
+         * When using a router, it specifies the transition direction when navigating to
+         * another page using `href`.
+         */
+        this.routerDirection = 'forward';
+        /**
+         * If `true`, activates a button with a heavier font weight.
+         */
+        this.strong = false;
+        /**
+         * The type of the button.
+         */
+        this.type = 'button';
         this.handleClick = (ev) => {
             const { el } = this;
             if (this.type === 'button') {
@@ -50,23 +75,6 @@ export class Button {
              */
             this.isCircle = this.hasIconOnly;
         };
-        this.isCircle = false;
-        this.color = undefined;
-        this.buttonType = 'button';
-        this.disabled = false;
-        this.expand = undefined;
-        this.fill = undefined;
-        this.routerDirection = 'forward';
-        this.routerAnimation = undefined;
-        this.download = undefined;
-        this.href = undefined;
-        this.rel = undefined;
-        this.shape = undefined;
-        this.size = undefined;
-        this.strong = false;
-        this.target = undefined;
-        this.type = 'button';
-        this.form = undefined;
     }
     disabledChanged() {
         const { disabled } = this;
@@ -260,6 +268,7 @@ export class Button {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -278,11 +287,13 @@ export class Button {
                     "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
             },
             "buttonType": {
                 "type": "string",
+                "attribute": "button-type",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -295,12 +306,14 @@ export class Button {
                     "tags": [],
                     "text": "The type of button."
                 },
-                "attribute": "button-type",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'button'"
             },
             "disabled": {
                 "type": "boolean",
+                "attribute": "disabled",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -313,12 +326,14 @@ export class Button {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the button."
                 },
-                "attribute": "disabled",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "false"
             },
             "expand": {
                 "type": "string",
+                "attribute": "expand",
                 "mutable": false,
                 "complexType": {
                     "original": "'full' | 'block'",
@@ -331,11 +346,13 @@ export class Button {
                     "tags": [],
                     "text": "Set to `\"block\"` for a full-width button or to `\"full\"` for a full-width button\nwith square corners and no left or right borders."
                 },
-                "attribute": "expand",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "fill": {
                 "type": "string",
+                "attribute": "fill",
                 "mutable": true,
                 "complexType": {
                     "original": "'clear' | 'outline' | 'solid' | 'default'",
@@ -348,11 +365,13 @@ export class Button {
                     "tags": [],
                     "text": "Set to `\"clear\"` for a transparent button that resembles a flat button, to `\"outline\"`\nfor a transparent button with a border, or to `\"solid\"` for a button with a filled background.\nThe default fill is `\"solid\"` except inside of a toolbar, where the default is `\"clear\"`."
                 },
-                "attribute": "fill",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "routerDirection": {
                 "type": "string",
+                "attribute": "router-direction",
                 "mutable": false,
                 "complexType": {
                     "original": "RouterDirection",
@@ -371,12 +390,14 @@ export class Button {
                     "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'"
             },
             "routerAnimation": {
                 "type": "unknown",
+                "attribute": "router-animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder | undefined",
@@ -394,10 +415,13 @@ export class Button {
                 "docs": {
                     "tags": [],
                     "text": "When using a router, it specifies the transition animation when navigating to\nanother page using `href`."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "download": {
                 "type": "string",
+                "attribute": "download",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -410,11 +434,13 @@ export class Button {
                     "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",
@@ -427,11 +453,13 @@ export class Button {
                     "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",
@@ -444,11 +472,13 @@ export class Button {
                     "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
             },
             "shape": {
                 "type": "string",
+                "attribute": "shape",
                 "mutable": false,
                 "complexType": {
                     "original": "'round'",
@@ -461,11 +491,13 @@ export class Button {
                     "tags": [],
                     "text": "Set to `\"round\"` for a button with more rounded corners."
                 },
-                "attribute": "shape",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "size": {
                 "type": "string",
+                "attribute": "size",
                 "mutable": false,
                 "complexType": {
                     "original": "'small' | 'default' | 'large'",
@@ -478,11 +510,13 @@ export class Button {
                     "tags": [],
                     "text": "Set to `\"small\"` for a button with less height and padding, to `\"default\"`\nfor a button with the default height and padding, or to `\"large\"` for a button\nwith more height and padding. By default the size is unset, unless the button\nis inside of an item, where the size is `\"small\"` by default. Set the size to\n`\"default\"` inside of an item to make it a standard size button."
                 },
-                "attribute": "size",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "strong": {
                 "type": "boolean",
+                "attribute": "strong",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -495,12 +529,14 @@ export class Button {
                     "tags": [],
                     "text": "If `true`, activates a button with a heavier font weight."
                 },
-                "attribute": "strong",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "target": {
                 "type": "string",
+                "attribute": "target",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -513,11 +549,13 @@ export class Button {
                     "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'",
@@ -530,12 +568,14 @@ export class Button {
                     "tags": [],
                     "text": "The type of the button."
                 },
-                "attribute": "type",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'button'"
             },
             "form": {
                 "type": "string",
+                "attribute": "form",
                 "mutable": false,
                 "complexType": {
                     "original": "string | HTMLFormElement",
@@ -553,7 +593,8 @@ export class Button {
                     "tags": [],
                     "text": "The HTML form element or form element id. Used to submit a form when the button is not a child of the form."
                 },
-                "attribute": "form",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             }
         };

package/dist/collection/components/buttons/buttons.js

@@ -5,6 +5,18 @@ import { Host, h } from "@stencil/core";
 import { getIonMode } from "../../global/ionic-global";
 export class Buttons {
     constructor() {
+        /**
+         * If true, buttons will disappear when its
+         * parent toolbar has fully collapsed if the toolbar
+         * is not the first toolbar. If the toolbar is the
+         * first toolbar, the buttons will be hidden and will
+         * only be shown once all toolbars have fully collapsed.
+         *
+         * Only applies in `ios` mode with `collapse` set to
+         * `true` on `ion-header`.
+         *
+         * Typically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)
+         */
         this.collapse = false;
     }
     render() {
@@ -32,6 +44,7 @@ export class Buttons {
         return {
             "collapse": {
                 "type": "boolean",
+                "attribute": "collapse",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -44,7 +57,8 @@ export class Buttons {
                     "tags": [],
                     "text": "If true, buttons will disappear when its\nparent toolbar has fully collapsed if the toolbar\nis not the first toolbar. If the toolbar is the\nfirst toolbar, the buttons will be hidden and will\nonly be shown once all toolbars have fully collapsed.\n\nOnly applies in `ios` mode with `collapse` set to\n`true` on `ion-header`.\n\nTypically used for [Collapsible Large Titles](https://ionicframework.com/docs/api/title#collapsible-large-titles)"
                 },
-                "attribute": "collapse",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             }