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

package/dist/collection/components/ripple-effect/ripple-effect.js

@@ -5,6 +5,15 @@ import { Host, h, readTask, writeTask } from "@stencil/core";
 import { getIonMode } from "../../global/ionic-global";
 export class RippleEffect {
     constructor() {
+        /**
+         * Sets the type of ripple-effect:
+         *
+         * - `bounded`: the ripple effect expands from the user's click position
+         * - `unbounded`: the ripple effect expands from the center of the button and overflows the container.
+         *
+         * NOTE: Surfaces for bounded ripples should have the overflow property set to hidden,
+         * while surfaces for unbounded ripples should have it set to visible.
+         */
         this.type = 'bounded';
     }
     /**
@@ -92,6 +101,8 @@ export class RippleEffect {
                     "tags": [],
                     "text": "Sets the type of ripple-effect:\n\n- `bounded`: the ripple effect expands from the user's click position\n- `unbounded`: the ripple effect expands from the center of the button and overflows the container.\n\nNOTE: Surfaces for bounded ripples should have the overflow property set to hidden,\nwhile surfaces for unbounded ripples should have it set to visible."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "type",
                 "reflect": false,
                 "defaultValue": "'bounded'"

package/dist/collection/components/route/route.js

@@ -1,11 +1,13 @@
 // TODO(FW-2832): types
 export class Route {
     constructor() {
+        /**
+         * Relative path that needs to match in order for this route to apply.
+         *
+         * Accepts paths similar to expressjs so that you can define parameters
+         * in the url /foo/:bar where bar would be available in incoming props.
+         */
         this.url = '';
-        this.component = undefined;
-        this.componentProps = undefined;
-        this.beforeLeave = undefined;
-        this.beforeEnter = undefined;
     }
     onUpdate(newValue) {
         this.ionRouteDataChanged.emit(newValue);
@@ -47,6 +49,8 @@ export class Route {
                     "tags": [],
                     "text": "Relative path that needs to match in order for this route to apply.\n\nAccepts paths similar to expressjs so that you can define parameters\nin the url /foo/:bar where bar would be available in incoming props."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "url",
                 "reflect": false,
                 "defaultValue": "''"
@@ -65,6 +69,8 @@ export class Route {
                     "tags": [],
                     "text": "Name of the component to load/select in the navigation outlet (`ion-tabs`, `ion-nav`)\nwhen the route matches.\n\nThe value of this property is not always the tagname of the component to load,\nin `ion-tabs` it actually refers to the name of the `ion-tab` to select."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "component",
                 "reflect": false
             },
@@ -81,7 +87,9 @@ export class Route {
                 "docs": {
                     "tags": [],
                     "text": "A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed\nto the defined component when rendered."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "beforeLeave": {
                 "type": "unknown",
@@ -102,7 +110,9 @@ export class Route {
                 "docs": {
                     "tags": [],
                     "text": "A navigation hook that is fired when the route tries to leave.\nReturning `true` allows the navigation to proceed, while returning\n`false` causes it to be cancelled. Returning a `NavigationHookOptions`\nobject causes the router to redirect to the path specified."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "beforeEnter": {
                 "type": "unknown",
@@ -123,7 +133,9 @@ export class Route {
                 "docs": {
                     "tags": [],
                     "text": "A navigation hook that is fired when the route tries to enter.\nReturning `true` allows the navigation to proceed, while returning\n`false` causes it to be cancelled. Returning a `NavigationHookOptions`\nobject causes the router to redirect to the path specified."
-                }
+                },
+                "getter": false,
+                "setter": false
             }
         };
     }

package/dist/collection/components/route-redirect/route-redirect.js

@@ -1,8 +1,4 @@
 export class RouteRedirect {
-    constructor() {
-        this.from = undefined;
-        this.to = undefined;
-    }
     propDidChange() {
         this.ionRouteRedirectChanged.emit();
     }
@@ -26,6 +22,8 @@ export class RouteRedirect {
                     "tags": [],
                     "text": "A redirect route, redirects \"from\" a URL \"to\" another URL. This property is that \"from\" URL.\nIt needs to be an exact match of the navigated URL in order to apply.\n\nThe path specified in this value is always an absolute path, even if the initial `/` slash\nis not specified."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "from",
                 "reflect": false
             },
@@ -43,6 +41,8 @@ export class RouteRedirect {
                     "tags": [],
                     "text": "A redirect route, redirects \"from\" a URL \"to\" another URL. This property is that \"to\" URL.\nWhen the defined `ion-route-redirect` rule matches, the router will redirect to the path\nspecified in this property.\n\nThe value of this property is always an absolute path inside the scope of routes defined in\n`ion-router` it can't be used with another router or to perform a redirection to a different domain.\n\nNote that this is a virtual redirect, it will not cause a real browser refresh, again, it's\na redirect inside the context of ion-router.\n\nWhen this property is not specified or his value is `undefined` the whole redirect route is noop,\neven if the \"from\" value matches."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "to",
                 "reflect": false
             }

package/dist/collection/components/router/router.js

@@ -11,7 +11,25 @@ export class Router {
         this.busy = false;
         this.state = 0;
         this.lastState = 0;
+        /**
+         * The root path to use when matching URLs. By default, this is set to "/", but you can specify
+         * an alternate prefix for all URL paths.
+         */
         this.root = '/';
+        /**
+         * The router can work in two "modes":
+         * - With hash: `/index.html#/path/to/page`
+         * - Without hash: `/path/to/page`
+         *
+         * Using one or another might depend in the requirements of your app and/or where it's deployed.
+         *
+         * Usually "hash-less" navigation works better for SEO and it's more user friendly too, but it might
+         * requires additional server-side configuration in order to properly work.
+         *
+         * On the other side hash-navigation is much easier to deploy, it even works over the file protocol.
+         *
+         * By default, this property is `true`, change to `false` to allow hash-less URLs.
+         */
         this.useHash = true;
     }
     async componentWillLoad() {
@@ -283,6 +301,8 @@ export class Router {
                     "tags": [],
                     "text": "The root path to use when matching URLs. By default, this is set to \"/\", but you can specify\nan alternate prefix for all URL paths."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "root",
                 "reflect": false,
                 "defaultValue": "'/'"
@@ -301,6 +321,8 @@ export class Router {
                     "tags": [],
                     "text": "The router can work in two \"modes\":\n- With hash: `/index.html#/path/to/page`\n- Without hash: `/path/to/page`\n\nUsing one or another might depend in the requirements of your app and/or where it's deployed.\n\nUsually \"hash-less\" navigation works better for SEO and it's more user friendly too, but it might\nrequires additional server-side configuration in order to properly work.\n\nOn the other side hash-navigation is much easier to deploy, it even works over the file protocol.\n\nBy default, this property is `true`, change to `false` to allow hash-less URLs."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "use-hash",
                 "reflect": false,
                 "defaultValue": "true"

package/dist/collection/components/router-link/router-link.js

@@ -6,15 +6,14 @@ import { createColorClasses, openURL } from "../../utils/theme";
 import { getIonMode } from "../../global/ionic-global";
 export class RouterLink {
     constructor() {
+        /**
+         * When using a router, it specifies the transition direction when navigating to
+         * another page using `href`.
+         */
+        this.routerDirection = 'forward';
         this.onClick = (ev) => {
             openURL(this.href, ev, this.routerDirection, this.routerAnimation);
         };
-        this.color = undefined;
-        this.href = undefined;
-        this.rel = undefined;
-        this.routerDirection = 'forward';
-        this.routerAnimation = undefined;
-        this.target = undefined;
     }
     render() {
         const mode = getIonMode(this);
@@ -62,6 +61,8 @@ export class RouterLink {
                     "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
             },
@@ -79,6 +80,8 @@ export class RouterLink {
                     "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
             },
@@ -96,6 +99,8 @@ export class RouterLink {
                     "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
             },
@@ -119,6 +124,8 @@ export class RouterLink {
                     "tags": [],
                     "text": "When using a router, it specifies the transition direction when navigating to\nanother page using `href`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "router-direction",
                 "reflect": false,
                 "defaultValue": "'forward'"
@@ -142,7 +149,9 @@ export class RouterLink {
                 "docs": {
                     "tags": [],
                     "text": "When using a router, it specifies the transition animation when navigating to\nanother page using `href`."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "target": {
                 "type": "string",
@@ -158,6 +167,8 @@ export class RouterLink {
                     "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
             }

package/dist/collection/components/router-outlet/router-outlet.js

@@ -13,11 +13,14 @@ export class RouterOutlet {
     constructor() {
         this.lockController = createLockController();
         this.gestureOrAnimationInProgress = false;
+        /**
+         * The mode determines which platform styles to use.
+         */
         this.mode = getIonMode(this);
-        this.delegate = undefined;
+        /**
+         * If `true`, the router-outlet should animate the transition of components.
+         */
         this.animated = true;
-        this.animation = undefined;
-        this.swipeHandler = undefined;
     }
     swipeHandlerChanged() {
         if (this.gesture) {
@@ -212,6 +215,8 @@ export class RouterOutlet {
                     "tags": [],
                     "text": "The mode determines which platform styles to use."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "mode",
                 "reflect": false,
                 "defaultValue": "getIonMode(this)"
@@ -238,7 +243,9 @@ export class RouterOutlet {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "animated": {
                 "type": "boolean",
@@ -254,6 +261,8 @@ export class RouterOutlet {
                     "tags": [],
                     "text": "If `true`, the router-outlet should animate the transition of components."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "animated",
                 "reflect": false,
                 "defaultValue": "true"
@@ -277,7 +286,9 @@ export class RouterOutlet {
                 "docs": {
                     "tags": [],
                     "text": "This property allows to create custom transition using AnimationBuilder functions."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "swipeHandler": {
                 "type": "unknown",
@@ -301,7 +312,9 @@ export class RouterOutlet {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             }
         };
     }

package/dist/collection/components/searchbar/searchbar.js

@@ -17,6 +17,81 @@ export class Searchbar {
         this.shouldAlignLeft = true;
         this.inputId = `ion-searchbar-${searchbarIds++}`;
         this.inheritedAttributes = {};
+        this.focused = false;
+        this.noAnimate = true;
+        /**
+         * If `true`, enable searchbar animation.
+         */
+        this.animated = false;
+        /**
+         * Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.
+         * Available options: `"off"`, `"none"`, `"on"`, `"sentences"`, `"words"`, `"characters"`.
+         */
+        this.autocapitalize = 'off';
+        /**
+         * Set the input's autocomplete property.
+         */
+        this.autocomplete = 'off';
+        /**
+         * Set the input's autocorrect property.
+         */
+        this.autocorrect = 'off';
+        /**
+         * Set the cancel button icon. Only applies to `md` mode.
+         * Defaults to `arrow-back-sharp`.
+         */
+        this.cancelButtonIcon = config.get('backButtonIcon', arrowBackSharp);
+        /**
+         * Set the the cancel button text. Only applies to `ios` mode.
+         */
+        this.cancelButtonText = 'Cancel';
+        /**
+         * If `true`, the user cannot interact with the input.
+         */
+        this.disabled = false;
+        /**
+         * If used in a form, set the name of the control, which is submitted with the form data.
+         */
+        this.name = this.inputId;
+        /**
+         * Set the input's placeholder.
+         * `placeholder` can accept either plaintext or HTML as a string.
+         * To display characters normally reserved for HTML, they
+         * must be escaped. For example `<Ionic>` would become
+         * `&lt;Ionic&gt;`
+         *
+         * For more information: [Security Documentation](https://ionicframework.com/docs/faq/security)
+         */
+        this.placeholder = 'Search';
+        /**
+         * Sets the behavior for the cancel button. Defaults to `"never"`.
+         * Setting to `"focus"` shows the cancel button on focus.
+         * Setting to `"never"` hides the cancel button.
+         * Setting to `"always"` shows the cancel button regardless
+         * of focus state.
+         */
+        this.showCancelButton = 'never';
+        /**
+         * Sets the behavior for the clear button. Defaults to `"focus"`.
+         * Setting to `"focus"` shows the clear button on focus if the
+         * input is not empty.
+         * Setting to `"never"` hides the clear button.
+         * Setting to `"always"` shows the clear button regardless
+         * of focus state, but only if the input is not empty.
+         */
+        this.showClearButton = 'always';
+        /**
+         * If `true`, enable spellcheck on the input.
+         */
+        this.spellcheck = false;
+        /**
+         * Set the type of the input.
+         */
+        this.type = 'search';
+        /**
+         * the value of the searchbar.
+         */
+        this.value = '';
         /**
          * Clears the input field and triggers the control change.
          */
@@ -113,30 +188,6 @@ export class Searchbar {
             this.ionFocus.emit();
             this.positionElements();
         };
-        this.focused = false;
-        this.noAnimate = true;
-        this.color = undefined;
-        this.animated = false;
-        this.autocapitalize = 'off';
-        this.autocomplete = 'off';
-        this.autocorrect = 'off';
-        this.cancelButtonIcon = config.get('backButtonIcon', arrowBackSharp);
-        this.cancelButtonText = 'Cancel';
-        this.clearIcon = undefined;
-        this.debounce = undefined;
-        this.disabled = false;
-        this.inputmode = undefined;
-        this.enterkeyhint = undefined;
-        this.maxlength = undefined;
-        this.minlength = undefined;
-        this.name = this.inputId;
-        this.placeholder = 'Search';
-        this.searchIcon = undefined;
-        this.showCancelButton = 'never';
-        this.showClearButton = 'always';
-        this.spellcheck = false;
-        this.type = 'search';
-        this.value = '';
     }
     /**
      * lang and dir are globally enumerated attributes.
@@ -434,6 +485,8 @@ export class Searchbar {
                     "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
             },
@@ -451,6 +504,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "If `true`, enable searchbar animation."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "animated",
                 "reflect": false,
                 "defaultValue": "false"
@@ -469,6 +524,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: `\"off\"`, `\"none\"`, `\"on\"`, `\"sentences\"`, `\"words\"`, `\"characters\"`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "autocapitalize",
                 "reflect": false,
                 "defaultValue": "'off'"
@@ -493,6 +550,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the input's autocomplete property."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "autocomplete",
                 "reflect": false,
                 "defaultValue": "'off'"
@@ -511,6 +570,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the input's autocorrect property."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "autocorrect",
                 "reflect": false,
                 "defaultValue": "'off'"
@@ -529,6 +590,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the cancel button icon. Only applies to `md` mode.\nDefaults to `arrow-back-sharp`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "cancel-button-icon",
                 "reflect": false,
                 "defaultValue": "config.get('backButtonIcon', arrowBackSharp) as string"
@@ -547,6 +610,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the the cancel button text. Only applies to `ios` mode."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "cancel-button-text",
                 "reflect": false,
                 "defaultValue": "'Cancel'"
@@ -565,6 +630,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the clear icon. Defaults to `close-circle` for `ios` and `close-sharp` for `md`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "clear-icon",
                 "reflect": false
             },
@@ -582,6 +649,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the amount of time, in milliseconds, to wait to trigger the `ionInput` event after each keystroke."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "debounce",
                 "reflect": false
             },
@@ -599,6 +668,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "If `true`, the user cannot interact with the input."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "disabled",
                 "reflect": false,
                 "defaultValue": "false"
@@ -617,6 +688,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "inputmode",
                 "reflect": false
             },
@@ -634,6 +707,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "A hint to the browser for which enter key to display.\nPossible values: `\"enter\"`, `\"done\"`, `\"go\"`, `\"next\"`,\n`\"previous\"`, `\"search\"`, and `\"send\"`."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "enterkeyhint",
                 "reflect": false
             },
@@ -651,6 +726,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "This attribute specifies the maximum number of characters that the user can enter."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "maxlength",
                 "reflect": false
             },
@@ -668,6 +745,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "This attribute specifies the minimum number of characters that the user can enter."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "minlength",
                 "reflect": false
             },
@@ -685,6 +764,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "If used in a form, set the name of the control, which is submitted with the form data."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "name",
                 "reflect": false,
                 "defaultValue": "this.inputId"
@@ -703,6 +784,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the input's placeholder.\n`placeholder` can accept either plaintext or HTML as a string.\nTo display characters normally reserved for HTML, they\nmust be escaped. For example `<Ionic>` would become\n`&lt;Ionic&gt;`\n\nFor more information: [Security Documentation](https://ionicframework.com/docs/faq/security)"
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "placeholder",
                 "reflect": false,
                 "defaultValue": "'Search'"
@@ -721,6 +804,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "The icon to use as the search icon. Defaults to `search-outline` in\n`ios` mode and `search-sharp` in `md` mode."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "search-icon",
                 "reflect": false
             },
@@ -738,6 +823,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Sets the behavior for the cancel button. Defaults to `\"never\"`.\nSetting to `\"focus\"` shows the cancel button on focus.\nSetting to `\"never\"` hides the cancel button.\nSetting to `\"always\"` shows the cancel button regardless\nof focus state."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "show-cancel-button",
                 "reflect": false,
                 "defaultValue": "'never'"
@@ -756,6 +843,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Sets the behavior for the clear button. Defaults to `\"focus\"`.\nSetting to `\"focus\"` shows the clear button on focus if the\ninput is not empty.\nSetting to `\"never\"` hides the clear button.\nSetting to `\"always\"` shows the clear button regardless\nof focus state, but only if the input is not empty."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "show-clear-button",
                 "reflect": false,
                 "defaultValue": "'always'"
@@ -774,6 +863,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "If `true`, enable spellcheck on the input."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "spellcheck",
                 "reflect": false,
                 "defaultValue": "false"
@@ -792,6 +883,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "Set the type of the input."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "type",
                 "reflect": false,
                 "defaultValue": "'search'"
@@ -810,6 +903,8 @@ export class Searchbar {
                     "tags": [],
                     "text": "the value of the searchbar."
                 },
+                "getter": false,
+                "setter": false,
                 "attribute": "value",
                 "reflect": false,
                 "defaultValue": "''"