@ionic/core 7.6.2-dev.11702957417.1622fcc0 → 7.6.2-dev.11704390532.1202188d

package/dist/collection/components/nav/nav.js

@@ -1026,21 +1026,29 @@ export class Nav {
                 "complexType": {
                     "signature": "<T extends NavComponent>(component: T, componentProps?: ComponentProps<T> | null, opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "component",
-                            "type": "T",
-                            "docs": "The component to push onto the navigation stack."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "component The component to push onto the navigation stack."
+                                }],
+                            "text": "The component to push onto the navigation stack."
                         }, {
-                            "name": "componentProps",
-                            "type": "ComponentProps<T> | null | undefined",
-                            "docs": "Any properties of the component."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "componentProps Any properties of the component."
+                                }],
+                            "text": "Any properties of the component."
                         }, {
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1095,25 +1103,35 @@ export class Nav {
                 "complexType": {
                     "signature": "<T extends NavComponent>(insertIndex: number, component: T, componentProps?: ComponentProps<T> | null, opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "insertIndex",
-                            "type": "number",
-                            "docs": "The index to insert the component at in the stack."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "insertIndex The index to insert the component at in the stack."
+                                }],
+                            "text": "The index to insert the component at in the stack."
                         }, {
-                            "name": "component",
-                            "type": "T",
-                            "docs": "The component to insert into the navigation stack."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "component The component to insert into the navigation stack."
+                                }],
+                            "text": "The component to insert into the navigation stack."
                         }, {
-                            "name": "componentProps",
-                            "type": "ComponentProps<T> | null | undefined",
-                            "docs": "Any properties of the component."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "componentProps Any properties of the component."
+                                }],
+                            "text": "Any properties of the component."
                         }, {
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1171,21 +1189,29 @@ export class Nav {
                 "complexType": {
                     "signature": "(insertIndex: number, insertComponents: NavComponent[] | NavComponentWithProps[], opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "insertIndex",
-                            "type": "number",
-                            "docs": "The index to insert the components at in the stack."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "insertIndex The index to insert the components at in the stack."
+                                }],
+                            "text": "The index to insert the components at in the stack."
                         }, {
-                            "name": "insertComponents",
-                            "type": "NavComponentWithProps<any>[] | NavComponent[]",
-                            "docs": "The components to insert into the navigation stack."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "insertComponents The components to insert into the navigation stack."
+                                }],
+                            "text": "The components to insert into the navigation stack."
                         }, {
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1236,13 +1262,17 @@ export class Nav {
                 "complexType": {
                     "signature": "(opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1277,17 +1307,23 @@ export class Nav {
                 "complexType": {
                     "signature": "(indexOrViewCtrl: number | ViewController, opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "indexOrViewCtrl",
-                            "type": "number | ViewController",
-                            "docs": "The index or view controller to pop to."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "indexOrViewCtrl The index or view controller to pop to."
+                                }],
+                            "text": "The index or view controller to pop to."
                         }, {
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1335,13 +1371,17 @@ export class Nav {
                 "complexType": {
                     "signature": "(opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1376,21 +1416,29 @@ export class Nav {
                 "complexType": {
                     "signature": "(startIndex: number, removeCount?: number, opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "startIndex",
-                            "type": "number",
-                            "docs": "The number to begin removal at."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "startIndex The number to begin removal at."
+                                }],
+                            "text": "The number to begin removal at."
                         }, {
-                            "name": "removeCount",
-                            "type": "number",
-                            "docs": "The number of components to remove."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "removeCount The number of components to remove."
+                                }],
+                            "text": "The number of components to remove."
                         }, {
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1431,21 +1479,29 @@ export class Nav {
                 "complexType": {
                     "signature": "<T extends NavComponent>(component: T, componentProps?: ComponentProps<T> | null, opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "component",
-                            "type": "T",
-                            "docs": "The component to set as the root of the navigation stack."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "component The component to set as the root of the navigation stack."
+                                }],
+                            "text": "The component to set as the root of the navigation stack."
                         }, {
-                            "name": "componentProps",
-                            "type": "ComponentProps<T> | null | undefined",
-                            "docs": "Any properties of the component."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "componentProps Any properties of the component."
+                                }],
+                            "text": "Any properties of the component."
                         }, {
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1500,17 +1556,23 @@ export class Nav {
                 "complexType": {
                     "signature": "(views: NavComponent[] | NavComponentWithProps[], opts?: NavOptions | null, done?: TransitionDoneFn) => Promise<boolean>",
                     "parameters": [{
-                            "name": "views",
-                            "type": "NavComponentWithProps<any>[] | NavComponent[]",
-                            "docs": "The list of views to set as the navigation stack."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "views The list of views to set as the navigation stack."
+                                }],
+                            "text": "The list of views to set as the navigation stack."
                         }, {
-                            "name": "opts",
-                            "type": "NavOptions | null | undefined",
-                            "docs": "The navigation options."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "opts The navigation options."
+                                }],
+                            "text": "The navigation options."
                         }, {
-                            "name": "done",
-                            "type": "TransitionDoneFn | undefined",
-                            "docs": "The transition complete function."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "done The transition complete function."
+                                }],
+                            "text": "The transition complete function."
                         }],
                     "references": {
                         "Promise": {
@@ -1558,21 +1620,29 @@ export class Nav {
                 "complexType": {
                     "signature": "(id: string, params: ComponentProps | undefined, direction: RouterDirection, animation?: AnimationBuilder) => Promise<RouteWrite>",
                     "parameters": [{
-                            "name": "id",
-                            "type": "string",
-                            "docs": "The component tag."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "id The component tag."
+                                }],
+                            "text": "The component tag."
                         }, {
-                            "name": "params",
-                            "type": "ComponentProps | undefined",
-                            "docs": "The component params."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "params The component params."
+                                }],
+                            "text": "The component params."
                         }, {
-                            "name": "direction",
-                            "type": "\"root\" | \"back\" | \"forward\"",
-                            "docs": "A direction hint."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "direction A direction hint."
+                                }],
+                            "text": "A direction hint."
                         }, {
-                            "name": "animation",
-                            "type": "AnimationBuilder | undefined",
-                            "docs": "an AnimationBuilder."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "animation an AnimationBuilder."
+                                }],
+                            "text": "an AnimationBuilder."
                         }],
                     "references": {
                         "Promise": {
@@ -1681,9 +1751,11 @@ export class Nav {
                 "complexType": {
                     "signature": "(index: number) => Promise<ViewController | undefined>",
                     "parameters": [{
-                            "name": "index",
-                            "type": "number",
-                            "docs": "The index of the view."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "index The index of the view."
+                                }],
+                            "text": "The index of the view."
                         }],
                     "references": {
                         "Promise": {
@@ -1710,9 +1782,11 @@ export class Nav {
                 "complexType": {
                     "signature": "(view?: ViewController) => Promise<boolean>",
                     "parameters": [{
-                            "name": "view",
-                            "type": "ViewController | undefined",
-                            "docs": "The view to check."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "view The view to check."
+                                }],
+                            "text": "The view to check."
                         }],
                     "references": {
                         "Promise": {
@@ -1739,9 +1813,11 @@ export class Nav {
                 "complexType": {
                     "signature": "(view?: ViewController) => Promise<ViewController | undefined>",
                     "parameters": [{
-                            "name": "view",
-                            "type": "ViewController | undefined",
-                            "docs": "The view to get."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "view The view to get."
+                                }],
+                            "text": "The view to get."
                         }],
                     "references": {
                         "Promise": {