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

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);
@@ -35,6 +37,7 @@ export class Route {
         return {
             "url": {
                 "type": "string",
+                "attribute": "url",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -47,12 +50,14 @@ 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."
                 },
-                "attribute": "url",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "''"
             },
             "component": {
                 "type": "string",
+                "attribute": "component",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -65,11 +70,13 @@ 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."
                 },
-                "attribute": "component",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "componentProps": {
                 "type": "unknown",
+                "attribute": "component-props",
                 "mutable": false,
                 "complexType": {
                     "original": "{ [key: string]: any }",
@@ -81,10 +88,13 @@ 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",
+                "attribute": "before-leave",
                 "mutable": false,
                 "complexType": {
                     "original": "NavigationHookCallback",
@@ -102,10 +112,13 @@ 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",
+                "attribute": "before-enter",
                 "mutable": false,
                 "complexType": {
                     "original": "NavigationHookCallback",
@@ -123,7 +136,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();
     }
@@ -14,6 +10,7 @@ export class RouteRedirect {
         return {
             "from": {
                 "type": "string",
+                "attribute": "from",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -26,11 +23,13 @@ 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."
                 },
-                "attribute": "from",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "to": {
                 "type": "string",
+                "attribute": "to",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined | null",
@@ -43,7 +42,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."
                 },
-                "attribute": "to",
+                "getter": false,
+                "setter": false,
                 "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() {
@@ -271,6 +289,7 @@ export class Router {
         return {
             "root": {
                 "type": "string",
+                "attribute": "root",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -283,12 +302,14 @@ 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."
                 },
-                "attribute": "root",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'/'"
             },
             "useHash": {
                 "type": "boolean",
+                "attribute": "use-hash",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -301,7 +322,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."
                 },
-                "attribute": "use-hash",
+                "getter": false,
+                "setter": false,
                 "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);
@@ -44,6 +43,7 @@ export class RouterLink {
         return {
             "color": {
                 "type": "string",
+                "attribute": "color",
                 "mutable": false,
                 "complexType": {
                     "original": "Color",
@@ -62,11 +62,13 @@ 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)."
                 },
-                "attribute": "color",
+                "getter": false,
+                "setter": false,
                 "reflect": true
             },
             "href": {
                 "type": "string",
+                "attribute": "href",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -79,11 +81,13 @@ 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."
                 },
-                "attribute": "href",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "rel": {
                 "type": "string",
+                "attribute": "rel",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -96,11 +100,13 @@ 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)."
                 },
-                "attribute": "rel",
+                "getter": false,
+                "setter": false,
                 "reflect": false
             },
             "routerDirection": {
                 "type": "string",
+                "attribute": "router-direction",
                 "mutable": false,
                 "complexType": {
                     "original": "RouterDirection",
@@ -119,12 +125,14 @@ export class RouterLink {
                     "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",
@@ -142,10 +150,13 @@ 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",
+                "attribute": "target",
                 "mutable": false,
                 "complexType": {
                     "original": "string | undefined",
@@ -158,7 +169,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\"`."
                 },
-                "attribute": "target",
+                "getter": false,
+                "setter": false,
                 "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) {
@@ -195,6 +198,7 @@ export class RouterOutlet {
         return {
             "mode": {
                 "type": "string",
+                "attribute": "mode",
                 "mutable": true,
                 "complexType": {
                     "original": "\"ios\" | \"md\"",
@@ -212,12 +216,14 @@ export class RouterOutlet {
                     "tags": [],
                     "text": "The mode determines which platform styles to use."
                 },
-                "attribute": "mode",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "getIonMode(this)"
             },
             "delegate": {
                 "type": "unknown",
+                "attribute": "delegate",
                 "mutable": false,
                 "complexType": {
                     "original": "FrameworkDelegate",
@@ -238,10 +244,13 @@ export class RouterOutlet {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "animated": {
                 "type": "boolean",
+                "attribute": "animated",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -254,12 +263,14 @@ export class RouterOutlet {
                     "tags": [],
                     "text": "If `true`, the router-outlet should animate the transition of components."
                 },
-                "attribute": "animated",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "animation": {
                 "type": "unknown",
+                "attribute": "animation",
                 "mutable": false,
                 "complexType": {
                     "original": "AnimationBuilder",
@@ -277,10 +288,13 @@ export class RouterOutlet {
                 "docs": {
                     "tags": [],
                     "text": "This property allows to create custom transition using AnimationBuilder functions."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "swipeHandler": {
                 "type": "unknown",
+                "attribute": "swipe-handler",
                 "mutable": false,
                 "complexType": {
                     "original": "SwipeGestureHandler",
@@ -301,7 +315,9 @@ export class RouterOutlet {
                             "text": undefined
                         }],
                     "text": ""
-                }
+                },
+                "getter": false,
+                "setter": false
             }
         };
     }