voyager-ionic-core 7.5.1 → 7.6.0

package/dist/types/components/route/route.d.ts

@@ -1,47 +1,47 @@
 import type { ComponentInterface, EventEmitter } from '../../stencil-public-runtime';
 import type { NavigationHookCallback } from './route-interface';
 export declare class Route implements ComponentInterface {
-  /**
-   * 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.
-   */
-  url: string;
-  /**
-   * Name of the component to load/select in the navigation outlet (`ion-tabs`, `ion-nav`)
-   * when the route matches.
-   *
-   * The value of this property is not always the tagname of the component to load,
-   * in `ion-tabs` it actually refers to the name of the `ion-tab` to select.
-   */
-  component: string;
-  /**
-   * A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed
-   * to the defined component when rendered.
-   */
-  componentProps?: {
-    [key: string]: any;
-  };
-  /**
-   * A navigation hook that is fired when the route tries to leave.
-   * Returning `true` allows the navigation to proceed, while returning
-   * `false` causes it to be cancelled. Returning a `NavigationHookOptions`
-   * object causes the router to redirect to the path specified.
-   */
-  beforeLeave?: NavigationHookCallback;
-  /**
-   * A navigation hook that is fired when the route tries to enter.
-   * Returning `true` allows the navigation to proceed, while returning
-   * `false` causes it to be cancelled. Returning a `NavigationHookOptions`
-   * object causes the router to redirect to the path specified.
-   */
-  beforeEnter?: NavigationHookCallback;
-  /**
-   * Used internally by `ion-router` to know when this route did change.
-   */
-  ionRouteDataChanged: EventEmitter<any>;
-  onUpdate(newValue: any): void;
-  onComponentProps(newValue: any, oldValue: any): void;
-  connectedCallback(): void;
+    /**
+     * 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.
+     */
+    url: string;
+    /**
+     * Name of the component to load/select in the navigation outlet (`ion-tabs`, `ion-nav`)
+     * when the route matches.
+     *
+     * The value of this property is not always the tagname of the component to load,
+     * in `ion-tabs` it actually refers to the name of the `ion-tab` to select.
+     */
+    component: string;
+    /**
+     * A key value `{ 'red': true, 'blue': 'white'}` containing props that should be passed
+     * to the defined component when rendered.
+     */
+    componentProps?: {
+        [key: string]: any;
+    };
+    /**
+     * A navigation hook that is fired when the route tries to leave.
+     * Returning `true` allows the navigation to proceed, while returning
+     * `false` causes it to be cancelled. Returning a `NavigationHookOptions`
+     * object causes the router to redirect to the path specified.
+     */
+    beforeLeave?: NavigationHookCallback;
+    /**
+     * A navigation hook that is fired when the route tries to enter.
+     * Returning `true` allows the navigation to proceed, while returning
+     * `false` causes it to be cancelled. Returning a `NavigationHookOptions`
+     * object causes the router to redirect to the path specified.
+     */
+    beforeEnter?: NavigationHookCallback;
+    /**
+     * Used internally by `ion-router` to know when this route did change.
+     */
+    ionRouteDataChanged: EventEmitter<any>;
+    onUpdate(newValue: any): void;
+    onComponentProps(newValue: any, oldValue: any): void;
+    connectedCallback(): void;
 }

package/dist/types/components/route-redirect/route-redirect.d.ts

@@ -1,36 +1,36 @@
 import type { ComponentInterface, EventEmitter } from '../../stencil-public-runtime';
 export declare class RouteRedirect implements ComponentInterface {
-  /**
-   * A redirect route, redirects "from" a URL "to" another URL. This property is that "from" URL.
-   * It needs to be an exact match of the navigated URL in order to apply.
-   *
-   * The path specified in this value is always an absolute path, even if the initial `/` slash
-   * is not specified.
-   *
-   */
-  from: string;
-  /**
-   * A redirect route, redirects "from" a URL "to" another URL. This property is that "to" URL.
-   * When the defined `ion-route-redirect` rule matches, the router will redirect to the path
-   * specified in this property.
-   *
-   * The value of this property is always an absolute path inside the scope of routes defined in
-   * `ion-router` it can't be used with another router or to perform a redirection to a different domain.
-   *
-   * Note that this is a virtual redirect, it will not cause a real browser refresh, again, it's
-   * a redirect inside the context of ion-router.
-   *
-   * When this property is not specified or his value is `undefined` the whole redirect route is noop,
-   * even if the "from" value matches.
-   */
-  to: string | undefined | null;
-  /**
-   * Internal event that fires when any value of this rule is added/removed from the DOM,
-   * or any of his public properties changes.
-   *
-   * `ion-router` captures this event in order to update his internal registry of router rules.
-   */
-  ionRouteRedirectChanged: EventEmitter;
-  propDidChange(): void;
-  connectedCallback(): void;
+    /**
+     * A redirect route, redirects "from" a URL "to" another URL. This property is that "from" URL.
+     * It needs to be an exact match of the navigated URL in order to apply.
+     *
+     * The path specified in this value is always an absolute path, even if the initial `/` slash
+     * is not specified.
+     *
+     */
+    from: string;
+    /**
+     * A redirect route, redirects "from" a URL "to" another URL. This property is that "to" URL.
+     * When the defined `ion-route-redirect` rule matches, the router will redirect to the path
+     * specified in this property.
+     *
+     * The value of this property is always an absolute path inside the scope of routes defined in
+     * `ion-router` it can't be used with another router or to perform a redirection to a different domain.
+     *
+     * Note that this is a virtual redirect, it will not cause a real browser refresh, again, it's
+     * a redirect inside the context of ion-router.
+     *
+     * When this property is not specified or his value is `undefined` the whole redirect route is noop,
+     * even if the "from" value matches.
+     */
+    to: string | undefined | null;
+    /**
+     * Internal event that fires when any value of this rule is added/removed from the DOM,
+     * or any of his public properties changes.
+     *
+     * `ion-router` captures this event in order to update his internal registry of router rules.
+     */
+    ionRouteRedirectChanged: EventEmitter;
+    propDidChange(): void;
+    connectedCallback(): void;
 }

package/dist/types/components/router/router.d.ts

@@ -1,77 +1,78 @@
 import type { ComponentInterface, EventEmitter } from '../../stencil-public-runtime';
-import type { AnimationBuilder, BackButtonEvent } from '../../interface';
+import type { BackButtonEvent } from "../../utils/hardware-back-button";
+import type { AnimationBuilder } from '../../interface';
 import type { RouterDirection, RouterEventDetail } from './utils/interface';
 export declare class Router implements ComponentInterface {
-  private previousPath;
-  private busy;
-  private state;
-  private lastState;
-  private waitPromise?;
-  el: HTMLElement;
-  /**
-   * 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.
-   */
-  root: string;
-  /**
-   * 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.
-   */
-  useHash: boolean;
-  /**
-   * Event emitted when the route is about to change
-   */
-  ionRouteWillChange: EventEmitter<RouterEventDetail>;
-  /**
-   * Emitted when the route had changed
-   */
-  ionRouteDidChange: EventEmitter<RouterEventDetail>;
-  componentWillLoad(): Promise<void>;
-  componentDidLoad(): void;
-  protected onPopState(): Promise<boolean>;
-  protected onBackButton(ev: BackButtonEvent): void;
-  /** @internal */
-  canTransition(): Promise<string | boolean>;
-  /**
-   * Navigate to the specified path.
-   *
-   * @param path The path to navigate to.
-   * @param direction The direction of the animation. Defaults to `"forward"`.
-   */
-  push(path: string, direction?: RouterDirection, animation?: AnimationBuilder): Promise<boolean>;
-  /** Go back to previous page in the window.history. */
-  back(): Promise<void>;
-  /** @internal */
-  printDebug(): Promise<void>;
-  /** @internal */
-  navChanged(direction: RouterDirection): Promise<boolean>;
-  /** This handler gets called when a `ion-route-redirect` component is added to the DOM or if the from or to property of such node changes. */
-  private onRedirectChanged;
-  /** This handler gets called when a `ion-route` component is added to the DOM or if the from or to property of such node changes. */
-  private onRoutesChanged;
-  private historyDirection;
-  private writeNavStateRoot;
-  private safeWriteNavState;
-  private lock;
-  /**
-   * Executes the beforeLeave hook of the source route and the beforeEnter hook of the target route if they exist.
-   *
-   * When the beforeLeave hook does not return true (to allow navigating) then that value is returned early and the beforeEnter is executed.
-   * Otherwise the beforeEnterHook hook of the target route is executed.
-   */
-  private runGuards;
-  private writeNavState;
-  private setSegments;
-  private getSegments;
-  private routeChangeEvent;
+    private previousPath;
+    private busy;
+    private state;
+    private lastState;
+    private waitPromise?;
+    el: HTMLElement;
+    /**
+     * 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.
+     */
+    root: string;
+    /**
+     * 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.
+     */
+    useHash: boolean;
+    /**
+     * Event emitted when the route is about to change
+     */
+    ionRouteWillChange: EventEmitter<RouterEventDetail>;
+    /**
+     * Emitted when the route had changed
+     */
+    ionRouteDidChange: EventEmitter<RouterEventDetail>;
+    componentWillLoad(): Promise<void>;
+    componentDidLoad(): void;
+    protected onPopState(): Promise<boolean>;
+    protected onBackButton(ev: BackButtonEvent): void;
+    /** @internal */
+    canTransition(): Promise<string | boolean>;
+    /**
+     * Navigate to the specified path.
+     *
+     * @param path The path to navigate to.
+     * @param direction The direction of the animation. Defaults to `"forward"`.
+     */
+    push(path: string, direction?: RouterDirection, animation?: AnimationBuilder): Promise<boolean>;
+    /** Go back to previous page in the window.history. */
+    back(): Promise<void>;
+    /** @internal */
+    printDebug(): Promise<void>;
+    /** @internal */
+    navChanged(direction: RouterDirection): Promise<boolean>;
+    /** This handler gets called when a `ion-route-redirect` component is added to the DOM or if the from or to property of such node changes. */
+    private onRedirectChanged;
+    /** This handler gets called when a `ion-route` component is added to the DOM or if the from or to property of such node changes. */
+    private onRoutesChanged;
+    private historyDirection;
+    private writeNavStateRoot;
+    private safeWriteNavState;
+    private lock;
+    /**
+     * Executes the beforeLeave hook of the source route and the beforeEnter hook of the target route if they exist.
+     *
+     * When the beforeLeave hook does not return true (to allow navigating) then that value is returned early and the beforeEnter is executed.
+     * Otherwise the beforeEnterHook hook of the target route is executed.
+     */
+    private runGuards;
+    private writeNavState;
+    private setSegments;
+    private getSegments;
+    private routeChangeEvent;
 }

package/dist/types/components/router/utils/dom.d.ts

@@ -15,7 +15,7 @@ export declare const writeNavState: (root: HTMLElement | undefined, chain: Route
  * The function returns a list of RouteID corresponding to each of the outlet and the last outlet without a RouteID.
  */
 export declare const readNavState: (root: HTMLElement | undefined) => Promise<{
-  ids: RouteID[];
-  outlet: NavOutletElement | undefined;
+    ids: RouteID[];
+    outlet: NavOutletElement | undefined;
 }>;
 export declare const waitUntilNavNode: () => Promise<void>;

package/dist/types/components/router/utils/interface.d.ts

@@ -1,55 +1,55 @@
 import type { AnimationBuilder, ComponentProps } from '../../../interface';
 import type { NavigationHookCallback } from '../../route/route-interface';
 export interface HTMLStencilElement extends HTMLElement {
-  componentOnReady(): Promise<this>;
+    componentOnReady(): Promise<this>;
 }
 export interface NavOutlet {
-  setRouteId(id: string, params: ComponentProps | undefined, direction: RouterDirection, animation?: AnimationBuilder): Promise<RouteWrite>;
-  getRouteId(): Promise<RouteID | undefined>;
+    setRouteId(id: string, params: ComponentProps | undefined, direction: RouterDirection, animation?: AnimationBuilder): Promise<RouteWrite>;
+    getRouteId(): Promise<RouteID | undefined>;
 }
 export interface RouterEventDetail {
-  from: string | null;
-  redirectedFrom: string | null;
-  to: string;
+    from: string | null;
+    redirectedFrom: string | null;
+    to: string;
 }
 export interface RouterCustomEvent extends CustomEvent {
-  detail: RouterEventDetail;
-  target: HTMLIonRouterElement;
+    detail: RouterEventDetail;
+    target: HTMLIonRouterElement;
 }
 export interface RouteRedirect {
-  from: string[];
-  to?: ParsedRoute;
+    from: string[];
+    to?: ParsedRoute;
 }
 export interface RouteWrite {
-  changed: boolean;
-  element: HTMLElement | undefined;
-  markVisible?: () => void | Promise<void>;
+    changed: boolean;
+    element: HTMLElement | undefined;
+    markVisible?: () => void | Promise<void>;
 }
 export interface RouteID {
-  id: string;
-  element: HTMLElement | undefined;
-  params?: {
-    [key: string]: any;
-  };
+    id: string;
+    element: HTMLElement | undefined;
+    params?: {
+        [key: string]: any;
+    };
 }
 export interface RouteEntry {
-  /** Component tag name or tab name. */
-  id: string;
-  segments: string[];
-  params: {
-    [key: string]: any;
-  } | undefined;
-  beforeLeave?: NavigationHookCallback;
-  beforeEnter?: NavigationHookCallback;
+    /** Component tag name or tab name. */
+    id: string;
+    segments: string[];
+    params: {
+        [key: string]: any;
+    } | undefined;
+    beforeLeave?: NavigationHookCallback;
+    beforeEnter?: NavigationHookCallback;
 }
 export interface RouteNode extends RouteEntry {
-  children: RouteTree;
+    children: RouteTree;
 }
 export interface ParsedRoute {
-  /** Parts of the route (non empty "/" separated parts of an URL). */
-  segments: string[];
-  /** Unparsed query string. */
-  queryString?: string;
+    /** Parts of the route (non empty "/" separated parts of an URL). */
+    segments: string[];
+    /** Unparsed query string. */
+    queryString?: string;
 }
 export type RouterDirection = 'forward' | 'back' | 'root';
 export type NavOutletElement = NavOutlet & HTMLStencilElement;

package/dist/types/components/router/utils/matching.d.ts

@@ -23,11 +23,11 @@ export declare const matchesSegments: (segments: string[], chain: RouteChain) =>
  * Returns undefined when both parameters are undefined.
  */
 export declare const mergeParams: (a: {
-  [key: string]: any;
+    [key: string]: any;
 } | undefined, b: {
-  [key: string]: any;
+    [key: string]: any;
 } | undefined) => {
-  [key: string]: any;
+    [key: string]: any;
 } | undefined;
 /**
  * Finds the best match for the ids in the chains.
@@ -58,7 +58,7 @@ export declare const findChainForSegments: (segments: string[], chains: RouteCha
  */
 export declare const computePriority: (chain: RouteChain) => number;
 export declare class RouterSegments {
-  private segments;
-  constructor(segments: string[]);
-  next(): string;
+    private segments;
+    constructor(segments: string[]);
+    next(): string;
 }

package/dist/types/components/router-link/router-link.d.ts

@@ -2,38 +2,38 @@ import type { ComponentInterface } from '../../stencil-public-runtime';
 import type { AnimationBuilder, Color } from '../../interface';
 import type { RouterDirection } from '../router/utils/interface';
 export declare class RouterLink implements ComponentInterface {
-  /**
-   * The color to use from your application's color palette.
-   * Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
-   * For more information on colors, see [theming](/docs/theming/basics).
-   */
-  color?: Color;
-  /**
-   * Contains a URL or a URL fragment that the hyperlink points to.
-   * If this property is set, an anchor tag will be rendered.
-   */
-  href: string | undefined;
-  /**
-   * Specifies the relationship of the target object to the link object.
-   * The value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types).
-   */
-  rel: string | undefined;
-  /**
-   * When using a router, it specifies the transition direction when navigating to
-   * another page using `href`.
-   */
-  routerDirection: RouterDirection;
-  /**
-   * When using a router, it specifies the transition animation when navigating to
-   * another page using `href`.
-   */
-  routerAnimation: AnimationBuilder | undefined;
-  /**
-   * Specifies where to display the linked URL.
-   * Only applies when an `href` is provided.
-   * Special keywords: `"_blank"`, `"_self"`, `"_parent"`, `"_top"`.
-   */
-  target: string | undefined;
-  private onClick;
-  render(): any;
+    /**
+     * The color to use from your application's color palette.
+     * Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
+     * For more information on colors, see [theming](/docs/theming/basics).
+     */
+    color?: Color;
+    /**
+     * Contains a URL or a URL fragment that the hyperlink points to.
+     * If this property is set, an anchor tag will be rendered.
+     */
+    href: string | undefined;
+    /**
+     * Specifies the relationship of the target object to the link object.
+     * The value is a space-separated list of [link types](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types).
+     */
+    rel: string | undefined;
+    /**
+     * When using a router, it specifies the transition direction when navigating to
+     * another page using `href`.
+     */
+    routerDirection: RouterDirection;
+    /**
+     * When using a router, it specifies the transition animation when navigating to
+     * another page using `href`.
+     */
+    routerAnimation: AnimationBuilder | undefined;
+    /**
+     * Specifies where to display the linked URL.
+     * Only applies when an `href` is provided.
+     * Special keywords: `"_blank"`, `"_self"`, `"_parent"`, `"_top"`.
+     */
+    target: string | undefined;
+    private onClick;
+    render(): any;
 }

package/dist/types/components/router-outlet/router-outlet.d.ts

@@ -3,45 +3,45 @@ import type { AnimationBuilder, ComponentProps, FrameworkDelegate } from '../../
 import type { RouterOutletOptions, SwipeGestureHandler } from '../nav/nav-interface';
 import type { RouteID, RouterDirection, RouteWrite, NavOutlet } from '../router/utils/interface';
 export declare class RouterOutlet implements ComponentInterface, NavOutlet {
-  private readonly lockController;
-  private activeEl;
-  private activeComponent;
-  private activeParams;
-  private gesture?;
-  private ani?;
-  private gestureOrAnimationInProgress;
-  el: HTMLElement;
-  /**
-   * The mode determines which platform styles to use.
-   */
-  mode: import("../../interface").Mode;
-  /** @internal */
-  delegate?: FrameworkDelegate;
-  /**
-   * If `true`, the router-outlet should animate the transition of components.
-   */
-  animated: boolean;
-  /** This property allows to create custom transition using AnimationBuilder functions. */
-  animation?: AnimationBuilder;
-  /** @internal */
-  swipeHandler?: SwipeGestureHandler;
-  swipeHandlerChanged(): void;
-  /** @internal */
-  ionNavWillLoad: EventEmitter<void>;
-  /** @internal */
-  ionNavWillChange: EventEmitter<void>;
-  /** @internal */
-  ionNavDidChange: EventEmitter<void>;
-  connectedCallback(): Promise<void>;
-  componentWillLoad(): void;
-  disconnectedCallback(): void;
-  /** @internal */
-  commit(enteringEl: HTMLElement, leavingEl: HTMLElement | undefined, opts?: RouterOutletOptions): Promise<boolean>;
-  /** @internal */
-  setRouteId(id: string, params: ComponentProps | undefined, direction: RouterDirection, animation?: AnimationBuilder): Promise<RouteWrite>;
-  /** @internal */
-  getRouteId(): Promise<RouteID | undefined>;
-  private setRoot;
-  private transition;
-  render(): any;
+    private readonly lockController;
+    private activeEl;
+    private activeComponent;
+    private activeParams;
+    private gesture?;
+    private ani?;
+    private gestureOrAnimationInProgress;
+    el: HTMLElement;
+    /**
+     * The mode determines which platform styles to use.
+     */
+    mode: import("../../interface").Mode;
+    /** @internal */
+    delegate?: FrameworkDelegate;
+    /**
+     * If `true`, the router-outlet should animate the transition of components.
+     */
+    animated: boolean;
+    /** This property allows to create custom transition using AnimationBuilder functions. */
+    animation?: AnimationBuilder;
+    /** @internal */
+    swipeHandler?: SwipeGestureHandler;
+    swipeHandlerChanged(): void;
+    /** @internal */
+    ionNavWillLoad: EventEmitter<void>;
+    /** @internal */
+    ionNavWillChange: EventEmitter<void>;
+    /** @internal */
+    ionNavDidChange: EventEmitter<void>;
+    connectedCallback(): Promise<void>;
+    componentWillLoad(): void;
+    disconnectedCallback(): void;
+    /** @internal */
+    commit(enteringEl: HTMLElement, leavingEl: HTMLElement | undefined, opts?: RouterOutletOptions): Promise<boolean>;
+    /** @internal */
+    setRouteId(id: string, params: ComponentProps | undefined, direction: RouterDirection, animation?: AnimationBuilder): Promise<RouteWrite>;
+    /** @internal */
+    getRouteId(): Promise<RouteID | undefined>;
+    private setRoot;
+    private transition;
+    render(): any;
 }

package/dist/types/components/row/row.d.ts

@@ -1,4 +1,4 @@
 import type { ComponentInterface } from '../../stencil-public-runtime';
 export declare class Row implements ComponentInterface {
-  render(): any;
+    render(): any;
 }

package/dist/types/components/searchbar/searchbar-interface.d.ts

@@ -1,12 +1,12 @@
 export interface SearchbarChangeEventDetail {
-  value?: string | null;
-  event?: Event;
+    value?: string | null;
+    event?: Event;
 }
 export interface SearchbarInputEventDetail {
-  value?: string | null;
-  event?: Event;
+    value?: string | null;
+    event?: Event;
 }
 export interface SearchbarCustomEvent extends CustomEvent {
-  detail: SearchbarChangeEventDetail;
-  target: HTMLIonSearchbarElement;
+    detail: SearchbarChangeEventDetail;
+    target: HTMLIonSearchbarElement;
 }