Interface UEPageFilterUser Exit

Точка расширения, фильтрующая маршруты

Example

export default {
    userExits: [
        {
            type: 'PageFilter',
            moduleId: 'pageFilter',
            active: true,
            system: false,
            meta: {},
            resolver() {
                return true;
            },
            fn(routeItem) {
                // Исключить маршрут вида '/unwanted-route/'
                return routeItem.route === '/unwanted-route/';
            },
        }
    ]
} satisfies Universe.Platform.UserExit.ExternalModuleDefault;

Deprecated

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

End Of Support

@universe-platform/router 2.0.0

Public

interface UEPageFilter {
    active: boolean;
    fn: ((pageItem: BaseRouteItem) => boolean);
    meta: {};
    moduleId: "pageFilter";
    resolver: AbstractUserExitResolver;
    system: boolean;
}

Hierarchy (view full)

Properties

active fn meta moduleId resolver system

Properties

active

active: boolean

Является ли экземпляр точки расширения активным

fn

fn: ((pageItem: BaseRouteItem) => boolean)

Функция фильтрации маршрута

meta

meta: {}

Мета-информация точки расширения

moduleId

moduleId

Уникальный идентификатор экземпляра точки расширения

resolver

resolver: AbstractUserExitResolver

Функция указывает, следует ли применять данный экземпляр точки расширения

system

system: boolean

Является ли системным экземпляром

On This Page

Properties