ionic-angular/navigation/nav-util.d.ts

A powerful framework for building mobile and progressive web apps with JavaScript and Angular

import { Renderer, TypeDecorator } from '@angular/core';
import { DeepLinker } from './deep-linker';
import { IonicPageMetadata } from './ionic-page';
import { ViewController } from './view-controller';
import { NavControllerBase } from './nav-controller-base';
import { Transition } from '../transitions/transition';
export declare function getComponent(linker: DeepLinker, nameOrPageOrView: any, params?: any): Promise<ViewController>;
export declare function convertToView(linker: DeepLinker, nameOrPageOrView: any, params: any): Promise<ViewController>;
export declare function convertToViews(linker: DeepLinker, pages: any[]): Promise<ViewController[]>;
export declare function setZIndex(nav: NavControllerBase, enteringView: ViewController, leavingView: ViewController, direction: string, renderer: Renderer): void;
export declare function isTabs(nav: any): boolean;
export declare function isTab(nav: any): boolean;
export declare function isNav(nav: any): boolean;
export declare function linkToSegment(navId: string, type: string, secondaryId: string, link: NavLink): NavSegment;
/**
 * @hidden
 */
export declare class DeepLinkMetadata implements IonicPageMetadata {
    component?: any;
    loadChildren?: string;
    name?: string;
    segment?: string;
    defaultHistory?: string[] | any[];
    priority?: string;
}
export interface DeepLinkDecorator extends TypeDecorator {
}
export interface DeepLinkMetadataFactory {
    (obj: IonicPageMetadata): DeepLinkDecorator;
    new (obj: IonicPageMetadata): DeepLinkMetadata;
}
/**
 * @hidden
 */
export declare var DeepLinkMetadataFactory: DeepLinkMetadataFactory;
/**
 * @hidden
 */
export interface DeepLinkConfig {
    links: DeepLinkMetadata[];
}
export interface NavLink {
    component?: any;
    loadChildren?: string;
    name?: string;
    segment?: string;
    segmentParts?: string[];
    segmentPartsLen?: number;
    staticLen?: number;
    dataLen?: number;
    dataKeys?: {
        [key: string]: boolean;
    };
    defaultHistory?: any[];
}
export interface NavResult {
    hasCompleted: boolean;
    requiresTransition: boolean;
    enteringName?: string;
    leavingName?: string;
    direction?: string;
}
export interface NavSegment extends DehydratedSegment {
    type: string;
    navId: string;
    secondaryId: string;
    requiresExplicitNavPrefix?: boolean;
}
export interface DehydratedSegment {
    id: string;
    name: string;
    component?: any;
    loadChildren?: string;
    data: any;
    defaultHistory?: NavSegment[];
    secondaryId?: string;
}
export interface DehydratedSegmentPair {
    segments: DehydratedSegment[];
    navGroup: NavGroup;
}
export interface NavGroup {
    type: string;
    navId: string;
    secondaryId: string;
    segmentPieces?: string[];
    tabSegmentPieces?: string[];
}
export interface NavOptions {
    animate?: boolean;
    animation?: string;
    direction?: string;
    duration?: number;
    easing?: string;
    id?: string;
    keyboardClose?: boolean;
    progressAnimation?: boolean;
    disableApp?: boolean;
    minClickBlockDuration?: number;
    ev?: any;
    updateUrl?: boolean;
    isNavRoot?: boolean;
}
export interface Page extends Function {
    new (...args: any[]): any;
}
export interface TransitionResolveFn {
    (hasCompleted: boolean, requiresTransition: boolean, enteringName?: string, leavingName?: string, direction?: string): void;
}
export interface TransitionRejectFn {
    (rejectReason: any, transition?: Transition): void;
}
export interface TransitionDoneFn {
    (hasCompleted: boolean, requiresTransition: boolean, enteringName?: string, leavingName?: string, direction?: string): void;
}
export interface TransitionInstruction {
    opts: NavOptions;
    insertStart?: number;
    insertViews?: any[];
    removeView?: ViewController;
    removeStart?: number;
    removeCount?: number;
    resolve?: (hasCompleted: boolean) => void;
    reject?: (rejectReason: string) => void;
    done?: TransitionDoneFn;
    leavingRequiresTransition?: boolean;
    enteringRequiresTransition?: boolean;
    requiresTransition?: boolean;
}
export declare const STATE_NEW = 1;
export declare const STATE_INITIALIZED = 2;
export declare const STATE_ATTACHED = 3;
export declare const STATE_DESTROYED = 4;
export declare const INIT_ZINDEX = 100;
export declare const DIRECTION_BACK = "back";
export declare const DIRECTION_FORWARD = "forward";
export declare const DIRECTION_SWITCH = "switch";
export declare const NAV = "nav";
export declare const TABS = "tabs";