123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836 |
- import { AllowedComponentProps } from 'vue';
- import { App } from 'vue';
- import type { Component } from 'vue';
- import { ComponentCustomProps } from 'vue';
- import { ComponentPublicInstance } from 'vue';
- import { ComputedRef } from 'vue';
- import type { DefineComponent } from 'vue';
- import type { InjectionKey } from 'vue';
- import { MaybeRef } from 'vue';
- import { Ref } from 'vue';
- import { UnwrapRef } from 'vue';
- import { VNode } from 'vue';
- import { VNodeProps } from 'vue';
- declare type Awaitable<T> = T | Promise<T>;
- export declare type _Awaitable<T> = T | PromiseLike<T>;
- export declare function createMemoryHistory(base?: string): RouterHistory;
- export declare function createRouter(options: RouterOptions): Router;
- export declare function createRouterMatcher(routes: Readonly<RouteRecordRaw[]>, globalOptions: PathParserOptions): RouterMatcher;
- export declare function createWebHashHistory(base?: string): RouterHistory;
- export declare function createWebHistory(base?: string): RouterHistory;
- declare interface _ErrorListener {
- (error: any, to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded): any;
- }
- export declare const enum ErrorTypes {
- MATCHER_NOT_FOUND = 1,
- NAVIGATION_GUARD_REDIRECT = 2,
- NAVIGATION_ABORTED = 4,
- NAVIGATION_CANCELLED = 8,
- NAVIGATION_DUPLICATED = 16
- }
- declare type HistoryLocation = string;
- export declare interface HistoryState {
- [x: number]: HistoryStateValue;
- [x: string]: HistoryStateValue;
- }
- declare interface HistoryStateArray extends Array<HistoryStateValue> {
- }
- declare type HistoryStateValue = string | number | boolean | null | undefined | HistoryState | HistoryStateArray;
- export declare function isNavigationFailure(error: any, type?: ErrorTypes.NAVIGATION_GUARD_REDIRECT): error is NavigationRedirectError;
- export declare function isNavigationFailure(error: any, type?: ErrorTypes | NavigationFailureType): error is NavigationFailure;
- declare type Lazy<T> = () => Promise<T>;
- declare type _LiteralUnion<LiteralType, BaseType extends string = string> = LiteralType | (BaseType & Record<never, never>);
- export declare function loadRouteLocation(route: RouteLocation | RouteLocationNormalized): Promise<RouteLocationNormalizedLoaded>;
- export declare interface LocationAsRelativeRaw {
- name?: RouteRecordNameGeneric;
-
- path?: undefined;
- params?: RouteParamsRawGeneric;
- }
- export declare type LocationQuery = Record<string, LocationQueryValue | LocationQueryValue[]>;
- export declare type LocationQueryRaw = Record<string | number, LocationQueryValueRaw | LocationQueryValueRaw[]>;
- export declare type LocationQueryValue = string | null;
- export declare type LocationQueryValueRaw = LocationQueryValue | number | undefined;
- export declare const matchedRouteKey: InjectionKey<ComputedRef<RouteRecordNormalized | undefined>>;
- export declare interface MatcherLocation {
-
- name: RouteRecordNameGeneric | null | undefined;
-
- path: string;
-
- params: RouteParamsGeneric;
-
- meta: RouteMeta;
-
- matched: RouteRecord[];
- }
- declare interface MatcherLocationAsName {
- name: RouteRecordNameGeneric;
-
- path?: undefined;
- params?: RouteParamsGeneric;
- }
- export declare interface MatcherLocationAsPath {
- path: string;
- }
- declare interface MatcherLocationAsRelative {
-
- path?: undefined;
- params?: RouteParamsGeneric;
- }
- declare type MatcherLocationRaw = MatcherLocationAsPath | MatcherLocationAsName | MatcherLocationAsRelative;
- declare interface NavigationCallback {
- (to: HistoryLocation, from: HistoryLocation, information: NavigationInformation): void;
- }
- declare enum NavigationDirection {
- back = "back",
- forward = "forward",
- unknown = ""
- }
- export declare interface NavigationFailure extends Error {
-
- type: ErrorTypes.NAVIGATION_CANCELLED | ErrorTypes.NAVIGATION_ABORTED | ErrorTypes.NAVIGATION_DUPLICATED;
-
- from: RouteLocationNormalized;
-
- to: RouteLocationNormalized;
- }
- export declare enum NavigationFailureType {
-
- aborted = 4,
-
- cancelled = 8,
-
- duplicated = 16
- }
- export declare interface NavigationGuard {
- (to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, next: NavigationGuardNext): _Awaitable<NavigationGuardReturn>;
- }
- export declare interface NavigationGuardNext {
- (): void;
- (error: Error): void;
- (location: RouteLocationRaw): void;
- (valid: boolean | undefined): void;
- (cb: NavigationGuardNextCallback): void;
- }
- export declare type NavigationGuardNextCallback = (vm: ComponentPublicInstance) => unknown;
- export declare type NavigationGuardReturn = void | Error | boolean | RouteLocationRaw;
- export declare interface NavigationGuardWithThis<T> {
- (this: T, to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, next: NavigationGuardNext): _Awaitable<NavigationGuardReturn>;
- }
- export declare interface NavigationHookAfter {
- (to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, failure?: NavigationFailure | void): unknown;
- }
- declare interface NavigationInformation {
- type: NavigationType;
- direction: NavigationDirection;
- delta: number;
- }
- export declare interface NavigationRedirectError extends Omit<NavigationFailure, 'to' | 'type'> {
- type: ErrorTypes.NAVIGATION_GUARD_REDIRECT;
- to: RouteLocationRaw;
- }
- declare enum NavigationType {
- pop = "pop",
- push = "push"
- }
- export declare function onBeforeRouteLeave(leaveGuard: NavigationGuard): void;
- export declare function onBeforeRouteUpdate(updateGuard: NavigationGuard): void;
- export declare type ParamValue<isRaw extends boolean> = true extends isRaw ? string | number : string;
- export declare type ParamValueOneOrMore<isRaw extends boolean> = [
- ParamValue<isRaw>,
- ...ParamValue<isRaw>[]
- ];
- export declare type ParamValueZeroOrMore<isRaw extends boolean> = true extends isRaw ? ParamValue<isRaw>[] | undefined | null : ParamValue<isRaw>[] | undefined;
- export declare type ParamValueZeroOrOne<isRaw extends boolean> = true extends isRaw ? string | number | null | undefined : string;
- export declare function parseQuery(search: string): LocationQuery;
- declare type PathParams = Record<string, string | string[]>;
- declare interface PathParser {
-
- re: RegExp;
-
- score: Array<number[]>;
-
- keys: PathParserParamKey[];
-
- parse(path: string): PathParams | null;
-
- stringify(params: PathParams): string;
- }
- export declare type PathParserOptions = Pick<_PathParserOptions, 'end' | 'sensitive' | 'strict'>;
- export declare interface _PathParserOptions {
-
- sensitive?: boolean;
-
- strict?: boolean;
-
- start?: boolean;
-
- end?: boolean;
- }
- declare interface PathParserParamKey {
- name: string;
- repeatable: boolean;
- optional: boolean;
- }
- declare type RawRouteComponent = RouteComponent | Lazy<RouteComponent>;
- export declare type RouteComponent = Component | DefineComponent;
- export declare type RouteLocation<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationGeneric : RouteLocationTypedList<RouteMap>[Name];
- export declare type RouteLocationAsPath<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationAsPathGeneric : RouteLocationAsPathTypedList<RouteMap>[Name];
- export declare interface RouteLocationAsPathGeneric extends RouteQueryAndHash, RouteLocationOptions {
-
- path: string;
- }
- export declare interface RouteLocationAsPathTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationAsPathGeneric {
- path: _LiteralUnion<RouteMap[Name]['path']>;
- }
- export declare type RouteLocationAsPathTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = {
- [N in keyof RouteMap]: RouteLocationAsPathTyped<RouteMap, N>;
- };
- export declare type RouteLocationAsRelative<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationAsRelativeGeneric : RouteLocationAsRelativeTypedList<RouteMap>[Name];
- export declare interface RouteLocationAsRelativeGeneric extends RouteQueryAndHash, RouteLocationOptions {
- name?: RouteRecordNameGeneric;
- params?: RouteParamsRawGeneric;
-
- path?: undefined;
- }
- export declare interface RouteLocationAsRelativeTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationAsRelativeGeneric {
- name?: Extract<Name, string | symbol>;
- params?: RouteMap[Name]['paramsRaw'];
- }
- export declare type RouteLocationAsRelativeTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = {
- [N in keyof RouteMap]: RouteLocationAsRelativeTyped<RouteMap, N>;
- };
- export declare type RouteLocationAsString<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? string : _LiteralUnion<RouteLocationAsStringTypedList<RouteMap>[Name], string>;
- export declare type RouteLocationAsStringTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> = RouteMap[Name]['path'];
- export declare type RouteLocationAsStringTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = {
- [N in keyof RouteMap]: RouteLocationAsStringTyped<RouteMap, N>;
- };
- export declare interface _RouteLocationBase extends Pick<MatcherLocation, 'name' | 'path' | 'params' | 'meta'> {
-
- fullPath: string;
-
- query: LocationQuery;
-
- hash: string;
-
- redirectedFrom: RouteLocation | undefined;
- }
- export declare interface RouteLocationGeneric extends _RouteLocationBase {
-
- matched: RouteRecord[];
- }
- export declare const routeLocationKey: InjectionKey<RouteLocationNormalizedLoaded>;
- export declare interface RouteLocationMatched extends RouteRecordNormalized {
- components: Record<string, RouteComponent> | null | undefined;
- }
- export declare interface RouteLocationNamedRaw extends RouteQueryAndHash, LocationAsRelativeRaw, RouteLocationOptions {
- }
- export declare type RouteLocationNormalized<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationNormalizedGeneric : RouteLocationNormalizedTypedList<RouteMap>[Name];
- export declare interface RouteLocationNormalizedGeneric extends _RouteLocationBase {
- name: RouteRecordNameGeneric;
- params: RouteParamsGeneric;
-
- matched: RouteRecordNormalized[];
- }
- export declare type RouteLocationNormalizedLoaded<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationNormalizedLoadedGeneric : RouteLocationNormalizedLoadedTypedList<RouteMap>[Name];
- export declare interface RouteLocationNormalizedLoadedGeneric extends RouteLocationNormalizedGeneric {
-
- matched: RouteLocationMatched[];
- }
- export declare interface RouteLocationNormalizedLoadedTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationNormalizedLoadedGeneric {
- name: Extract<Name, string | symbol>;
- params: RouteMap[Name]['params'];
- }
- export declare type RouteLocationNormalizedLoadedTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = {
- [N in keyof RouteMap]: RouteLocationNormalizedLoadedTyped<RouteMap, N>;
- };
- export declare interface RouteLocationNormalizedTyped<RouteMap extends RouteMapGeneric = RouteMapGeneric, Name extends keyof RouteMap = keyof RouteMap> extends RouteLocationNormalizedGeneric {
- name: Extract<Name, string | symbol>;
- params: RouteMap[Name]['params'];
-
- matched: RouteRecordNormalized[];
- }
- export declare type RouteLocationNormalizedTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = {
- [N in keyof RouteMap]: RouteLocationNormalizedTyped<RouteMap, N>;
- };
- export declare interface RouteLocationOptions {
-
- replace?: boolean;
-
- force?: boolean;
-
- state?: HistoryState;
- }
- export declare interface RouteLocationPathRaw extends RouteQueryAndHash, MatcherLocationAsPath, RouteLocationOptions {
- }
- export declare type RouteLocationRaw<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationAsString | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric : _LiteralUnion<RouteLocationAsStringTypedList<RouteMap>[Name], string> | RouteLocationAsRelativeTypedList<RouteMap>[Name] | RouteLocationAsPathTypedList<RouteMap>[Name];
- export declare type RouteLocationResolved<Name extends keyof RouteMap = keyof RouteMap> = RouteMapGeneric extends RouteMap ? RouteLocationResolvedGeneric : RouteLocationResolvedTypedList<RouteMap>[Name];
- export declare interface RouteLocationResolvedGeneric extends RouteLocationGeneric {
-
- href: string;
- }
- export declare interface RouteLocationResolvedTyped<RouteMap extends RouteMapGeneric, Name extends keyof RouteMap> extends RouteLocationTyped<RouteMap, Name> {
-
- href: string;
- }
- export declare type RouteLocationResolvedTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = {
- [N in keyof RouteMap]: RouteLocationResolvedTyped<RouteMap, N>;
- };
- export declare interface RouteLocationTyped<RouteMap extends RouteMapGeneric, Name extends keyof RouteMap> extends RouteLocationGeneric {
- name: Extract<Name, string | symbol>;
- params: RouteMap[Name]['params'];
- }
- export declare type RouteLocationTypedList<RouteMap extends RouteMapGeneric = RouteMapGeneric> = {
- [N in keyof RouteMap]: RouteLocationTyped<RouteMap, N>;
- };
- export declare type RouteMap = TypesConfig extends Record<'RouteNamedMap', infer RouteNamedMap> ? RouteNamedMap : RouteMapGeneric;
- export declare type RouteMapGeneric = Record<string | symbol, RouteRecordInfo>;
- export declare interface RouteMeta extends Record<string | number | symbol, unknown> {
- }
- export declare type RouteParams<Name extends keyof RouteMap = keyof RouteMap> = RouteMap[Name]['params'];
- export declare type RouteParamsGeneric = Record<string, RouteParamValue | RouteParamValue[]>;
- export declare type RouteParamsRaw<Name extends keyof RouteMap = keyof RouteMap> = RouteMap[Name]['paramsRaw'];
- export declare type RouteParamsRawGeneric = Record<string, RouteParamValueRaw | Exclude<RouteParamValueRaw, null | undefined>[]>;
- export declare type RouteParamValue = string;
- export declare type RouteParamValueRaw = RouteParamValue | number | null | undefined;
- export declare interface RouteQueryAndHash {
- query?: LocationQueryRaw;
- hash?: string;
- }
- export declare interface Router {
-
-
- readonly currentRoute: Ref<RouteLocationNormalizedLoaded>;
-
- readonly options: RouterOptions;
-
- listening: boolean;
-
- addRoute(parentName: NonNullable<RouteRecordNameGeneric>, route: RouteRecordRaw): () => void;
-
- addRoute(route: RouteRecordRaw): () => void;
-
- removeRoute(name: NonNullable<RouteRecordNameGeneric>): void;
-
- hasRoute(name: NonNullable<RouteRecordNameGeneric>): boolean;
-
- getRoutes(): RouteRecord[];
-
- clearRoutes(): void;
-
- resolve<Name extends keyof RouteMap = keyof RouteMap>(to: RouteLocationAsRelativeTyped<RouteMap, Name>, currentLocation?: RouteLocationNormalizedLoaded): RouteLocationResolved<Name>;
- resolve(to: RouteLocationAsString | RouteLocationAsRelative | RouteLocationAsPath, currentLocation?: RouteLocationNormalizedLoaded): RouteLocationResolved;
-
- push(to: RouteLocationRaw): Promise<NavigationFailure | void | undefined>;
-
- replace(to: RouteLocationRaw): Promise<NavigationFailure | void | undefined>;
-
- back(): ReturnType<Router['go']>;
-
- forward(): ReturnType<Router['go']>;
-
- go(delta: number): void;
-
- beforeEach(guard: NavigationGuardWithThis<undefined>): () => void;
-
- beforeResolve(guard: NavigationGuardWithThis<undefined>): () => void;
-
- afterEach(guard: NavigationHookAfter): () => void;
-
- onError(handler: _ErrorListener): () => void;
-
- isReady(): Promise<void>;
-
- install(app: App): void;
- }
- export declare type RouteRecord = RouteRecordNormalized;
- export declare interface _RouteRecordBase extends PathParserOptions {
-
- path: string;
-
- redirect?: RouteRecordRedirectOption;
-
- alias?: string | string[];
-
- name?: RouteRecordNameGeneric;
-
- beforeEnter?: NavigationGuardWithThis<undefined> | NavigationGuardWithThis<undefined>[];
-
- meta?: RouteMeta;
-
- children?: RouteRecordRaw[];
-
- props?: _RouteRecordProps | Record<string, _RouteRecordProps>;
- }
- export declare interface RouteRecordInfo<Name extends string | symbol = string, Path extends string = string, ParamsRaw extends RouteParamsRawGeneric = RouteParamsRawGeneric, Params extends RouteParamsGeneric = RouteParamsGeneric, Meta extends RouteMeta = RouteMeta> {
- name: Name;
- path: Path;
- paramsRaw: ParamsRaw;
- params: Params;
- meta: Meta;
- }
- declare interface RouteRecordMatcher extends PathParser {
- record: RouteRecord;
- parent: RouteRecordMatcher | undefined;
- children: RouteRecordMatcher[];
- alias: RouteRecordMatcher[];
- }
- export declare interface RouteRecordMultipleViews extends _RouteRecordBase {
-
- components: Record<string, RawRouteComponent>;
- component?: never;
- children?: never;
- redirect?: never;
-
- props?: Record<string, _RouteRecordProps> | boolean;
- }
- export declare interface RouteRecordMultipleViewsWithChildren extends _RouteRecordBase {
-
- components?: Record<string, RawRouteComponent> | null | undefined;
- component?: never;
- children: RouteRecordRaw[];
-
- props?: Record<string, _RouteRecordProps> | boolean;
- }
- export declare type RouteRecordName = RouteMapGeneric extends RouteMap ? RouteRecordNameGeneric : keyof RouteMap;
- export declare type RouteRecordNameGeneric = string | symbol | undefined;
- export declare interface RouteRecordNormalized {
-
- path: _RouteRecordBase['path'];
-
- redirect: _RouteRecordBase['redirect'] | undefined;
-
- name: _RouteRecordBase['name'];
-
- components: RouteRecordMultipleViews['components'] | null | undefined;
-
- mods: Record<string, unknown>;
-
- children: RouteRecordRaw[];
-
- meta: Exclude<_RouteRecordBase['meta'], void>;
-
- props: Record<string, _RouteRecordProps>;
-
- beforeEnter: _RouteRecordBase['beforeEnter'];
-
- leaveGuards: Set<NavigationGuard>;
-
- updateGuards: Set<NavigationGuard>;
-
- enterCallbacks: Record<string, NavigationGuardNextCallback[]>;
-
- instances: Record<string, ComponentPublicInstance | undefined | null>;
-
- aliasOf: RouteRecordNormalized | undefined;
- }
- export declare type _RouteRecordProps<Name extends keyof RouteMap = keyof RouteMap> = boolean | Record<string, any> | ((to: RouteLocationNormalized<Name>) => Record<string, any>);
- export declare type RouteRecordRaw = RouteRecordSingleView | RouteRecordSingleViewWithChildren | RouteRecordMultipleViews | RouteRecordMultipleViewsWithChildren | RouteRecordRedirect;
- /**
- * Route Record that defines a redirect. Cannot have `component` or `components`
- * as it is never rendered.
- */
- export declare interface RouteRecordRedirect extends _RouteRecordBase {
- redirect: RouteRecordRedirectOption;
- component?: never;
- components?: never;
- props?: never;
- }
- /**
- * @internal
- */
- export declare type RouteRecordRedirectOption = RouteLocationRaw | ((to: RouteLocation) => RouteLocationRaw);
- /**
- * Route Record defining one single component with the `component` option.
- */
- export declare interface RouteRecordSingleView extends _RouteRecordBase {
- /**
- * Component to display when the URL matches this route.
- */
- component: RawRouteComponent;
- components?: never;
- children?: never;
- redirect?: never;
- /**
- * Allow passing down params as props to the component rendered by `router-view`.
- */
- props?: _RouteRecordProps;
- }
- /**
- * Route Record defining one single component with a nested view.
- */
- export declare interface RouteRecordSingleViewWithChildren extends _RouteRecordBase {
- /**
- * Component to display when the URL matches this route.
- */
- component?: RawRouteComponent | null | undefined;
- components?: never;
- children: RouteRecordRaw[];
- /**
- * Allow passing down params as props to the component rendered by `router-view`.
- */
- props?: _RouteRecordProps;
- }
- /**
- * Interface implemented by History implementations that can be passed to the
- * router as {@link Router.history}
- *
- * @alpha
- */
- export declare interface RouterHistory {
- /**
- * Base path that is prepended to every url. This allows hosting an SPA at a
- * sub-folder of a domain like `example.com/sub-folder` by having a `base` of
- * `/sub-folder`
- */
- readonly base: string;
- /**
- * Current History location
- */
- readonly location: HistoryLocation;
- /**
- * Current History state
- */
- readonly state: HistoryState;
- /**
- * Navigates to a location. In the case of an HTML5 History implementation,
- * this will call `history.pushState` to effectively change the URL.
- *
- * @param to - location to push
- * @param data - optional {@link HistoryState} to be associated with the
- * navigation entry
- */
- push(to: HistoryLocation, data?: HistoryState): void;
- /**
- * Same as {@link RouterHistory.push} but performs a `history.replaceState`
- * instead of `history.pushState`
- *
- * @param to - location to set
- * @param data - optional {@link HistoryState} to be associated with the
- * navigation entry
- */
- replace(to: HistoryLocation, data?: HistoryState): void;
- /**
- * Traverses history in a given direction.
- *
- * @example
- * ```js
- * myHistory.go(-1) // equivalent to window.history.back()
- * myHistory.go(1) // equivalent to window.history.forward()
- * ```
- *
- * @param delta - distance to travel. If delta is \< 0, it will go back,
- * if it's \> 0, it will go forward by that amount of entries.
- * @param triggerListeners - whether this should trigger listeners attached to
- * the history
- */
- go(delta: number, triggerListeners?: boolean): void;
- /**
- * Attach a listener to the History implementation that is triggered when the
- * navigation is triggered from outside (like the Browser back and forward
- * buttons) or when passing `true` to {@link RouterHistory.back} and
- * {@link RouterHistory.forward}
- *
- * @param callback - listener to attach
- * @returns a callback to remove the listener
- */
- listen(callback: NavigationCallback): () => void;
-
- createHref(location: HistoryLocation): string;
-
- destroy(): void;
- }
- export declare const routerKey: InjectionKey<Router>;
- export declare const RouterLink: _RouterLinkI;
- export declare interface _RouterLinkI {
- new (): {
- $props: AllowedComponentProps & ComponentCustomProps & VNodeProps & RouterLinkProps;
- $slots: {
- default?: ({ route, href, isActive, isExactActive, navigate, }: UnwrapRef<UseLinkReturn>) => VNode[];
- };
- };
-
- useLink: typeof useLink;
- }
- declare interface RouterLinkOptions {
-
- to: RouteLocationRaw;
-
- replace?: boolean;
- }
- export declare interface RouterLinkProps extends RouterLinkOptions {
-
- custom?: boolean;
-
- activeClass?: string;
-
- exactActiveClass?: string;
-
- ariaCurrentValue?: 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false';
-
- viewTransition?: boolean;
- }
- export declare interface RouterMatcher {
- addRoute: (record: RouteRecordRaw, parent?: RouteRecordMatcher) => () => void;
- removeRoute(matcher: RouteRecordMatcher): void;
- removeRoute(name: NonNullable<RouteRecordNameGeneric>): void;
- clearRoutes: () => void;
- getRoutes: () => RouteRecordMatcher[];
- getRecordMatcher: (name: NonNullable<RouteRecordNameGeneric>) => RouteRecordMatcher | undefined;
-
- resolve: (location: MatcherLocationRaw, currentLocation: MatcherLocation) => MatcherLocation;
- }
- export declare interface RouterOptions extends PathParserOptions {
-
- history: RouterHistory;
-
- routes: Readonly<RouteRecordRaw[]>;
-
- scrollBehavior?: RouterScrollBehavior;
-
- parseQuery?: typeof parseQuery;
-
- stringifyQuery?: typeof stringifyQuery;
-
- linkActiveClass?: string;
-
- linkExactActiveClass?: string;
- }
- export declare interface RouterScrollBehavior {
-
- (to: RouteLocationNormalized, from: RouteLocationNormalizedLoaded, savedPosition: _ScrollPositionNormalized | null): Awaitable<ScrollPosition | false | void>;
- }
- export declare const RouterView: {
- new (): {
- $props: AllowedComponentProps & ComponentCustomProps & VNodeProps & RouterViewProps;
- $slots: {
- default?: ({ Component, route, }: {
- Component: VNode;
- route: RouteLocationNormalizedLoaded;
- }) => VNode[];
- };
- };
- };
- export declare const routerViewLocationKey: InjectionKey<Ref<RouteLocationNormalizedLoaded>>;
- export declare interface RouterViewProps {
- name?: string;
- route?: RouteLocationNormalized;
- }
- declare type ScrollPosition = ScrollPositionCoordinates | ScrollPositionElement;
- declare type ScrollPositionCoordinates = {
- behavior?: ScrollOptions['behavior'];
- left?: number;
- top?: number;
- };
- declare interface ScrollPositionElement extends ScrollToOptions {
-
- el: string | Element;
- }
- declare type _ScrollPositionNormalized = {
- behavior?: ScrollOptions['behavior'];
- left: number;
- top: number;
- };
- export declare const START_LOCATION: RouteLocationNormalizedLoaded;
- export declare function stringifyQuery(query: LocationQueryRaw): string;
- export declare interface TypesConfig {
- }
- export declare function useLink<Name extends keyof RouteMap = keyof RouteMap>(props: UseLinkOptions<Name>): UseLinkReturn<Name>;
- export declare interface UseLinkOptions<Name extends keyof RouteMap = keyof RouteMap> {
- to: MaybeRef<RouteLocationAsString | RouteLocationAsRelativeTyped<RouteMap, Name> | RouteLocationAsPath | RouteLocationRaw>;
- replace?: MaybeRef<boolean | undefined>;
-
- viewTransition?: boolean;
- }
- export declare interface UseLinkReturn<Name extends keyof RouteMap = keyof RouteMap> {
- route: ComputedRef<RouteLocationResolved<Name>>;
- href: ComputedRef<string>;
- isActive: ComputedRef<boolean>;
- isExactActive: ComputedRef<boolean>;
- navigate(e?: MouseEvent): Promise<void | NavigationFailure>;
- }
- export declare function useRoute<Name extends keyof RouteMap = keyof RouteMap>(_name?: Name): RouteLocationNormalizedLoaded<Name>;
- export declare function useRouter(): Router;
- export declare const viewDepthKey: InjectionKey<Ref<number> | number>;
- export { }
- declare module 'vue' {
- export interface ComponentCustomOptions {
-
- beforeRouteEnter?: TypesConfig extends Record<'beforeRouteEnter', infer T>
- ? T
- : NavigationGuardWithThis<undefined>
-
- beforeRouteUpdate?: TypesConfig extends Record<'beforeRouteUpdate', infer T>
- ? T
- : NavigationGuard
-
- beforeRouteLeave?: TypesConfig extends Record<'beforeRouteLeave', infer T>
- ? T
- : NavigationGuard
- }
- export interface ComponentCustomProperties {
-
- $route: TypesConfig extends Record<'$route', infer T>
- ? T
- : RouteLocationNormalizedLoaded
-
- $router: TypesConfig extends Record<'$router', infer T> ? T : Router
- }
- export interface GlobalComponents {
- RouterView: TypesConfig extends Record<'RouterView', infer T>
- ? T
- : typeof RouterView
- RouterLink: TypesConfig extends Record<'RouterLink', infer T>
- ? T
- : typeof RouterLink
- }
- }
|