@ionic/core 7.6.2-dev.11702954699.17da50be → 7.6.2-dev.11703182244.1165aeec

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

@@ -104,13 +104,17 @@ export class RippleEffect {
                 "complexType": {
                     "signature": "(x: number, y: number) => Promise<() => void>",
                     "parameters": [{
-                            "name": "x",
-                            "type": "number",
-                            "docs": "The horizontal coordinate of where the ripple should start."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "x The horizontal coordinate of where the ripple should start."
+                                }],
+                            "text": "The horizontal coordinate of where the ripple should start."
                         }, {
-                            "name": "y",
-                            "type": "number",
-                            "docs": "The vertical coordinate of where the ripple should start."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "y The vertical coordinate of where the ripple should start."
+                                }],
+                            "text": "The vertical coordinate of where the ripple should start."
                         }],
                     "references": {
                         "Promise": {

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

@@ -378,17 +378,20 @@ export class Router {
                 "complexType": {
                     "signature": "(path: string, direction?: RouterDirection, animation?: AnimationBuilder) => Promise<boolean>",
                     "parameters": [{
-                            "name": "path",
-                            "type": "string",
-                            "docs": "The path to navigate to."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "path The path to navigate to."
+                                }],
+                            "text": "The path to navigate to."
                         }, {
-                            "name": "direction",
-                            "type": "\"root\" | \"back\" | \"forward\"",
-                            "docs": "The direction of the animation. Defaults to `\"forward\"`."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "direction The direction of the animation. Defaults to `\"forward\"`."
+                                }],
+                            "text": "The direction of the animation. Defaults to `\"forward\"`."
                         }, {
-                            "name": "animation",
-                            "type": "AnimationBuilder | undefined",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }],
                     "references": {
                         "Promise": {
@@ -460,9 +463,8 @@ export class Router {
                 "complexType": {
                     "signature": "(direction: RouterDirection) => Promise<boolean>",
                     "parameters": [{
-                            "name": "direction",
-                            "type": "\"root\" | \"back\" | \"forward\"",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }],
                     "references": {
                         "Promise": {

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

@@ -368,17 +368,14 @@ export class RouterOutlet {
                 "complexType": {
                     "signature": "(enteringEl: HTMLElement, leavingEl: HTMLElement | undefined, opts?: RouterOutletOptions) => Promise<boolean>",
                     "parameters": [{
-                            "name": "enteringEl",
-                            "type": "HTMLElement",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }, {
-                            "name": "leavingEl",
-                            "type": "HTMLElement | undefined",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }, {
-                            "name": "opts",
-                            "type": "RouterOutletOptions | undefined",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }],
                     "references": {
                         "Promise": {
@@ -409,21 +406,17 @@ export class RouterOutlet {
                 "complexType": {
                     "signature": "(id: string, params: ComponentProps | undefined, direction: RouterDirection, animation?: AnimationBuilder) => Promise<RouteWrite>",
                     "parameters": [{
-                            "name": "id",
-                            "type": "string",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }, {
-                            "name": "params",
-                            "type": "ComponentProps | undefined",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }, {
-                            "name": "direction",
-                            "type": "\"root\" | \"back\" | \"forward\"",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }, {
-                            "name": "animation",
-                            "type": "AnimationBuilder | undefined",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }],
                     "references": {
                         "Promise": {

package/dist/collection/components/select/select.js

@@ -1205,9 +1205,11 @@ Developers can use the "legacy" property to continue using the legacy form marku
                 "complexType": {
                     "signature": "(event?: UIEvent) => Promise<any>",
                     "parameters": [{
-                            "name": "event",
-                            "type": "UIEvent | undefined",
-                            "docs": "The user interface event that called the open."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "event The user interface event that called the open."
+                                }],
+                            "text": "The user interface event that called the open."
                         }],
                     "references": {
                         "Promise": {

package/dist/collection/components/tabs/tabs.js

@@ -236,9 +236,11 @@ export class Tabs {
                 "complexType": {
                     "signature": "(tab: string | HTMLIonTabElement) => Promise<boolean>",
                     "parameters": [{
-                            "name": "tab",
-                            "type": "string | HTMLIonTabElement",
-                            "docs": "The tab instance to select. If passed a string, it should be the value of the tab's `tab` property."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property."
+                                }],
+                            "text": "The tab instance to select. If passed a string, it should be the value of the tab's `tab` property."
                         }],
                     "references": {
                         "Promise": {
@@ -264,9 +266,11 @@ export class Tabs {
                 "complexType": {
                     "signature": "(tab: string | HTMLIonTabElement) => Promise<HTMLIonTabElement | undefined>",
                     "parameters": [{
-                            "name": "tab",
-                            "type": "string | HTMLIonTabElement",
-                            "docs": "The tab instance to select. If passed a string, it should be the value of the tab's `tab` property."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "tab The tab instance to select. If passed a string, it should be the value of the tab's `tab` property."
+                                }],
+                            "text": "The tab instance to select. If passed a string, it should be the value of the tab's `tab` property."
                         }],
                     "references": {
                         "Promise": {
@@ -309,9 +313,8 @@ export class Tabs {
                 "complexType": {
                     "signature": "(id: string) => Promise<RouteWrite>",
                     "parameters": [{
-                            "name": "id",
-                            "type": "string",
-                            "docs": ""
+                            "tags": [],
+                            "text": ""
                         }],
                     "references": {
                         "Promise": {

package/dist/collection/components/toast/toast.js

@@ -1026,13 +1026,17 @@ export class Toast {
                 "complexType": {
                     "signature": "(data?: any, role?: string) => Promise<boolean>",
                     "parameters": [{
-                            "name": "data",
-                            "type": "any",
-                            "docs": "Any data to emit in the dismiss events."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "data Any data to emit in the dismiss events."
+                                }],
+                            "text": "Any data to emit in the dismiss events."
                         }, {
-                            "name": "role",
-                            "type": "string | undefined",
-                            "docs": "The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`."
+                            "tags": [{
+                                    "name": "param",
+                                    "text": "role The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`."
+                                }],
+                            "text": "The role of the element that is dismissing the toast.\nThis can be useful in a button handler for determining which button was\nclicked to dismiss the toast.\nSome examples include: ``\"cancel\"`, `\"destructive\"`, \"selected\"`, and `\"backdrop\"`."
                         }],
                     "references": {
                         "Promise": {

package/dist/docs.d.ts

@@ -60,10 +60,30 @@ interface ComponentCompilerEventComplexType {
 }
 interface ComponentCompilerMethodComplexType {
   signature: string;
-  parameters: JsonDocMethodParameter[];
+  parameters: CompilerJsDoc[];
   references: ComponentCompilerTypeReferences;
   return: string;
 }
+interface CompilerJsDoc {
+  /**
+   * The text associated with the JSDoc
+   */
+  text: string;
+  /**
+   * Tags included in the JSDoc
+   */
+  tags: CompilerJsDocTagInfo[];
+}
+interface CompilerJsDocTagInfo {
+  /**
+   * The name of the tag - e.g. `@deprecated`
+   */
+  name: string;
+  /**
+   * Additional text that is associated with the tag - e.g. `@deprecated use v2 of this API`
+   */
+  text?: string;
+}
 /**
  * The Type Library holds information about the types which are used in a
  * Stencil project. During compilation, Stencil gathers information about the