Search
    Preparing search index...

    Interface RouterStoreType

    interface RouterStoreType {
        history: History;
        location: Location;
        get currentRoute(): undefined | RouteItem<any, any>;
        get defaultPage(): string;
        get fullSearch(): SearchObj;
        get groupTitleKey(): PageGroups;
        get menuList(): MenuGroup[];
        get routes(): BaseRouteItem[];
        addRouteDisableCondition<T extends keyof IRouteMeta>(
            key: T,
            condition: DisableRouteCondition,
        ): void;
        clearSearch(replace?: true): void;
        clearState(replace?: true): void;
        deleteSearch(key: string, replace?: true): void;
        disableRoute<T extends keyof IRouteMeta>(key: T): void;
        getCurrentPage(): null | PageComponentType;
        getMatchParams(): undefined | Match<any>;
        getRouteDescriptor<T extends keyof IRouteMeta>(
            name: T,
        ): undefined | RouteDescriptor<T>;
        getSearch(key: string): undefined | string;
        getSearchString(obj: { [key: string]: string }): string;
        hasRouteAccess<T extends keyof IRouteMeta>(
            name: T,
            ...params: RouteDescriptorParams<T>,
        ): any;
        isRouteExist<T extends keyof IRouteMeta>(key: T): boolean;
        openTab<T extends keyof IRouteMeta>(
            name: T,
            ...param: RouteDescriptorParams<T>,
        ): void;
        overrideRoute<T extends keyof IRouteMeta>(
            key: T,
            route: Partial<IRouteMeta[T]>,
        ): void;
        parseSearch(search: string, key?: string): undefined | string | SearchObj;
        registerRoute<T extends keyof IRouteMeta>(
            key: T,
            route: IRouteMeta[T],
        ): void;
        registerRoutes(routes: Partial<IRouteMeta>): void;
        reloadRoutes(): void;
        removeRouteDisableCondition<T extends keyof IRouteMeta>(key: T): void;
        replaceRoute<T extends keyof IRouteMeta>(
            name: T,
            ...param: RouteDescriptorParams<T>,
        ): void;
        setCurrentPage(page: null | PageComponentType): void;
        setNewRoute(pathname?: string, searchObj?: SearchObj, replace?: true): void;
        setPath(path: string, replace?: true): void;
        setRoute<T extends keyof IRouteMeta>(
            name: T,
            ...param: RouteDescriptorParams<T>,
        ): void;
        setSearch(obj: { [key: string]: string }, replace?: true): void;
        setSearchItem(key: string, value: string, replace?: true): void;
        undisableRoute<T extends keyof IRouteMeta>(key: T): void;
    }
    Index

    Properties

    history location

    Accessors

    currentRoute defaultPage fullSearch groupTitleKey menuList routes

    Methods

    addRouteDisableCondition clearSearch clearState deleteSearch disableRoute getCurrentPage getMatchParams getRouteDescriptor getSearch getSearchString hasRouteAccess isRouteExist openTab overrideRoute parseSearch registerRoute registerRoutes reloadRoutes removeRouteDisableCondition replaceRoute setCurrentPage setNewRoute setPath setRoute setSearch setSearchItem undisableRoute

    Properties

    history: History

    История навигации.

    location: Location

    Текущее положение в истории.

    Accessors

    • get currentRoute(): undefined | RouteItem<any, any>

      Геттер, текущего маршрута.

      Returns undefined | RouteItem<any, any>

    • get defaultPage(): string

      Геттер, значения страницы по умолчанию.

      Returns string

    • get fullSearch(): SearchObj

      Геттер, текущих параметров поиска.

      Returns SearchObj

    • get groupTitleKey(): PageGroups

      Геттер, текущая группы страниц.

      Returns PageGroups

    • Геттер, списка групп меню.

      Returns MenuGroup[]

    • get routes(): BaseRouteItem[]

      Геттер, списока всех маршрутов.

      Returns BaseRouteItem[]

    Methods

    • Метод для отключения определенных роутов по переданному условию. Рекомендуется использовать этот метод только при инициации приложения Отключение роутов происходит в reloadRoutes

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      Returns void

    • Очищает все параметры поиска.

      Parameters

      • Optionalreplace: true

        Флаг замены в истории.

      Returns void

    • Очищает объект состояния.

      Parameters

      • Optionalreplace: true

        Флаг замены в истории.

      Returns void

    • Удаляет один из параметров поиска.

      Parameters

      • key: string

        Имя параметра.

      • Optionalreplace: true

        Флаг замены в истории.

      Returns void

    • Method for disable some routes in extended app's This method will delete route from route list, so you couldn't use deleted route in future You should call this method only in bootstrap of application in "initRouter" method (Unidata.initRouter)

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      • key: T

      Returns void

      Для отключения/включения роутов необходимо использовать addRouteDisableCondition и removeRouteDisableCondition

      @universe-platform/router 2.0.0

    • Возвращает параметры сопоставления маршрута.

      Returns undefined | Match<any>

    • Возвращает дескриптор маршрута по ключу.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      • name: T

        Имя маршрута.

      Returns undefined | RouteDescriptor<T>

    • Возвращает значение одного параметра поиска.

      Parameters

      • key: string

        Имя параметра.

      Returns undefined | string

    • Преобразует объект параметров в строку.

      Parameters

      • obj: { [key: string]: string }

        Объект с параметрами.

      Returns string

    • Метод проверки прав на переданный роут с параметрами

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      Returns any

      Возвращает boolean значение доступности роута текущему пользователю. Если роута не существует или у роута отсутсвует routeAccessor будет возвращен true

    • Проверяет, зарегистрирован ли маршрут.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      • key: T

        Ключ маршрута.

      Returns boolean

    • Открывает маршрут в новой вкладке.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      Returns void

    • Переопределяет параметры зарегистрированного маршрута.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      • key: T

        Ключ маршрута.

      • route: Partial<IRouteMeta[T]>

        Данные маршрута

      Returns void

    • Парсит строку поиска в объект или возвращает конкретное значение по ключу.

      Parameters

      • search: string

        Строка поиска.

      • Optionalkey: string

        Имя ключа, если нужно вернуть значение одного параметра.

      Returns undefined | string | SearchObj

    • Регистрирует указанный маршрут.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      • key: T

        Ключ маршрута.

      • route: IRouteMeta[T]

        Данные маршрута.

      Returns void

    • Регистрирует все маршруты в хранилище.

      Parameters

      • routes: Partial<IRouteMeta>

        Объект частичного описания маршрутов.

      Returns void

    • Перезагружает списки маршрутов, учитывая условия их отключения.

      Returns void

    • Удаляет условие отключения маршрута.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      • key: T

        Ключ маршрута.

      Returns void

    • Заменяет текущий маршрут по ключу.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      Returns void

    • Устанавливает текущую страницу.

      Parameters

      • page: null | PageComponentType

        Экземпляр React-компонента или null.

      Returns void

    • Устанавливает новый маршрут с параметрами.

      Parameters

      • Optionalpathname: string

        Путь маршрута.

      • OptionalsearchObj: SearchObj

        Объект параметров поиска.

      • Optionalreplace: true

        Флаг замены в истории.

      Returns void

    • Устанавливает путь в истории.

      Parameters

      • path: string

        Строка перехода.

      • Optionalreplace: true

        Флаг замены в истории.

      Returns void

    • Устанавливает текущий маршрут по его ключу.

      Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      Returns void

    • Устанавливает набор параметров поиска.

      Parameters

      • obj: { [key: string]: string }

        Объект с параметрами.

      • Optionalreplace: true

        Флаг замены в истории.

      Returns void

    • Устанавливает один параметр поиска.

      Parameters

      • key: string

        Имя параметра.

      • value: string

        Значение параметра.

      • Optionalreplace: true

        Флаг замены в истории.

      Returns void

    • Type Parameters

      • T extends keyof IRouteMeta

      Parameters

      • key: T

      Returns void

      Для отключения/включения роутов необходимо использовать addRouteDisableCondition и removeRouteDisableCondition

      @universe-platform/router 2.0.0

    On This Page

    Properties
    Accessors
    Methods