Юниверс DG SDK UI
v2.15.0

Интерфейс RouterStoreType

interface RouterStoreType {
    history: History;
    location: Location;
    get currentRoute(): RouteItem<any, any> | undefined;
    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(): PageComponentType | null;
    getMatchParams(): Match<any> | undefined;
    getRouteDescriptor<T extends keyof IRouteMeta>(
        name: T,
    ): RouteDescriptor<T> | undefined;
    getSearch(key: string): string | undefined;
    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;
    isRouteRegistered<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<UniverseRouter.IRouteMeta[T]>,
    ): void;
    parseSearch(search: string, key?: string): string | SearchObj | undefined;
    registerRoute<T extends keyof IRouteMeta>(
        key: T,
        route: IRouteMeta[T],
    ): void;
    registerRoutes(routes: Partial<UniverseRouter.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: PageComponentType | null): 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;
}
Индекс

Свойства

history location

Акцессоры

currentRoute defaultPage fullSearch groupTitleKey menuList routes

Методы

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

Свойства

history: History

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

location: Location

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

Акцессоры

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

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

    Возвращает RouteItem<any, any> | undefined

  • get defaultPage(): string

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

    Возвращает string

  • get fullSearch(): SearchObj

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

    Возвращает SearchObj

  • get groupTitleKey(): PageGroups

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

    Возвращает PageGroups

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

    Возвращает MenuGroup[]

Методы

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    Возвращает void

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

    Параметры

    • Optionalreplace: true

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

    Возвращает void

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

    Параметры

    • Optionalreplace: true

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

    Возвращает void

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

    Параметры

    • key: string

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

    • Optionalreplace: true

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

    Возвращает 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)

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • key: T

    Возвращает void

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

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

    Возвращает Match<any> | undefined

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • name: T

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

    Возвращает RouteDescriptor<T> | undefined

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

    Параметры

    • key: string

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

    Возвращает string | undefined

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

    Параметры

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

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

    Возвращает string

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    Возвращает any

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

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • key: T

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

    Возвращает boolean

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • key: T

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

    Возвращает boolean

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    Возвращает void

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • key: T

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

    • route: Partial<UniverseRouter.IRouteMeta[T]>

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

    Возвращает void

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

    Параметры

    • search: string

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

    • Optionalkey: string

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

    Возвращает string | SearchObj | undefined

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • key: T

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

    • route: IRouteMeta[T]

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

    Возвращает void

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

    Параметры

    • routes: Partial<UniverseRouter.IRouteMeta>

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

    Возвращает void

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

    Возвращает void

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • key: T

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

    Возвращает void

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    Возвращает void

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

    Параметры

    • page: PageComponentType | null

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

    Возвращает void

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

    Параметры

    • Optionalpathname: string

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

    • OptionalsearchObj: SearchObj

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

    • Optionalreplace: true

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

    Возвращает void

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

    Параметры

    • path: string

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

    • Optionalreplace: true

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

    Возвращает void

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

    Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    Возвращает void

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

    Параметры

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

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

    • Optionalreplace: true

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

    Возвращает void

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

    Параметры

    • key: string

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

    • value: string

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

    • Optionalreplace: true

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

    Возвращает void

  • Параметры типа

    • T extends keyof IRouteMeta

    Параметры

    • key: T

    Возвращает void

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

© Авторские права 2025, Юниверс Дата.

Настройки

Видимость элементов?

На этой странице

Свойства
Акцессоры
Методы