@kitbag/router 0.26.1 → 0.28.0

package/dist/components/routerLink.d.ts

@@ -1,8 +1,7 @@
-import { UrlString } from '../types/urlString';
 import { ResolvedRoute } from '../types/resolved';
 import { EmitsOptions, InjectionKey, SlotsType, VNode } from 'vue';
 import { Router } from '../types/router';
-import { RouterLinkProps, ToCallback } from '../types/routerLink';
+import { RouterLinkProps } from '../types/routerLink';
 type RouterLinkSlots = {
     default?: (props: {
         route: ResolvedRoute | undefined;
@@ -11,6 +10,7 @@ type RouterLinkSlots = {
         isActive: boolean;
         isExactActive: boolean;
         isExternal: boolean;
+        isTransitioning: boolean;
     }) => VNode[];
 };
 export declare function createRouterLink<TRouter extends Router>(routerKey: InjectionKey<TRouter>): import('vue').DefineSetupFnComponent<RouterLinkProps<TRouter>, EmitsOptions, SlotsType<RouterLinkSlots>, import('../main').RouterPushOptions & {
@@ -23,11 +23,12 @@ export declare function createRouterLink<TRouter extends Router>(routerKey: Inje
             [x: string]: unknown;
         };
         state: import('../types/state').ExtractRouteStateParamsAsOptional<Record<string, import('../main').Param>>;
-        href: UrlString;
+        href: import('../main').UrlString;
+        canonical: import('../main').UrlString;
         query: URLSearchParams;
         hash: string;
         getTitle: import('../types/routeTitle').GetTitleCallback;
-    }> | UrlString | ToCallback<TRouter>;
+    }> | import('../main').UrlString | import('../types/routerLink').ToCallback<TRouter>;
     prefetch?: import('../main').PrefetchConfig;
     target?: string;
 } & ({

package/dist/components/routerProgress.d.ts

@@ -0,0 +1,18 @@
+import { InjectionKey } from 'vue';
+import { Router } from '../types/router';
+export type RouterProgressProps = {
+    /**
+     * How long a navigation must be pending before the bar appears, in milliseconds. Fast navigations never
+     * flash a bar. Defaults to 150.
+     */
+    delay?: number;
+    /**
+     * The color of the bar. Defaults to the `--router-progress-color` custom property, then a blue.
+     */
+    color?: string;
+    /**
+     * The accessible name of the bar, read out by screen readers. Defaults to "Loading page".
+     */
+    label?: string;
+};
+export declare function createRouterProgress<TRouter extends Router>(routerKey: InjectionKey<TRouter>): import('vue').DefineSetupFnComponent<RouterProgressProps, {}, {}, RouterProgressProps & {}, import('vue').PublicProps>;

package/dist/components/routerProgressBar.d.ts

@@ -0,0 +1,12 @@
+import { UseNavigation } from '../types/navigation';
+export type RouterProgressBarProps = {
+    navigation: UseNavigation;
+    delay: number;
+    color: string | undefined;
+    label: string;
+};
+/**
+ * The bar itself. RouterProgress mounts one instance per navigation, so the delay, the trickle, and the
+ * width all start fresh when the next navigation replaces it.
+ */
+export declare const routerProgressBar: import('vue').DefineSetupFnComponent<RouterProgressBarProps, {}, {}, RouterProgressBarProps & {}, import('vue').PublicProps>;

package/dist/components/viewTransition.browser.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/viewTransition.d.ts

@@ -0,0 +1,16 @@
+import { ComputedRef, InjectionKey, NativeElements, ComponentPublicInstance, HTMLAttributes } from 'vue';
+type ElementAttributes<TElement extends keyof HTMLElementTagNameMap> = TElement extends keyof NativeElements ? NativeElements[TElement] : HTMLAttributes;
+export type ViewTransitionProps<TElement extends keyof HTMLElementTagNameMap = 'span'> = {
+    /** The name shared by the outgoing and incoming elements. */
+    name: string;
+    /** The element to render. Defaults to span. */
+    as?: TElement;
+} & Omit<ElementAttributes<NoInfer<TElement>>, 'name'>;
+type ViewTransitionComponent = new <TElement extends keyof HTMLElementTagNameMap = 'span'>(props: ViewTransitionProps<TElement>) => ComponentPublicInstance<ViewTransitionProps<TElement>>;
+export declare const viewTransitionLinkKey: InjectionKey<ComputedRef<boolean>>;
+/**
+ * Names an element for a view transition. Inside RouterLink the name is active only while transitioning
+ * to that link's destination; elsewhere the element always carries its name.
+ */
+export declare const ViewTransition: ViewTransitionComponent;
+export {};

package/dist/components/viewTransition.spec-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/compositions/useLink.d.ts

@@ -9,8 +9,8 @@ type UseLinkArgs<TRouter extends Router, TSource extends RouterRouteName<TRouter
 type UseLinkFunction<TRouter extends Router> = {
     <TRouteKey extends RouterRouteName<TRouter>>(name: MaybeRefOrGetter<TRouteKey>, ...args: UseLinkArgs<TRouter, TRouteKey>): UseLink;
     (url: MaybeRefOrGetter<UrlString>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
-    (resolvedRoute: MaybeRefOrGetter<ResolvedRoute | undefined>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
-    (source: MaybeRefOrGetter<string | ResolvedRoute | undefined>, paramsOrOptions?: MaybeRefOrGetter<Record<PropertyKey, unknown> | UseLinkOptions>, maybeOptions?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
+    (resolvedRoute: MaybeRefOrGetter<ResolvedRoute>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
+    (source: MaybeRefOrGetter<UrlString | ResolvedRoute>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
 };
 export declare function createUseLink<TRouter extends Router>(routerKey: InjectionKey<TRouter>): UseLinkFunction<TRouter>;
 export {};

package/dist/compositions/useLink.spec-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/compositions/useNavigation.browser.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/compositions/useNavigation.d.ts

@@ -0,0 +1,5 @@
+import { InjectionKey } from 'vue';
+import { UseNavigation } from '../types/navigation';
+import { Router } from '../types/router';
+export declare const getNavigationProgressKey: (routerKey: InjectionKey<Router>) => InjectionKey<UseNavigation>;
+export declare function createUseNavigation<TRouter extends Router>(routerKey: InjectionKey<TRouter>): () => UseNavigation;

package/dist/compositions/useViewTransition.d.ts

@@ -0,0 +1,5 @@
+import { InjectionKey } from 'vue';
+import { Router, RouterRoutes } from '../types/router';
+import { RouterViewTransition } from '../types/viewTransition';
+export declare const getViewTransitionKey: (routerKey: InjectionKey<Router>) => InjectionKey<RouterViewTransition>;
+export declare function createUseViewTransition<TRouter extends Router>(routerKey: InjectionKey<TRouter>): () => RouterViewTransition<RouterRoutes<TRouter>>;

package/dist/errors/contextRedirectError.d.ts

@@ -1,7 +1,6 @@
 import { CallbackContextRedirect } from '../types/callbackContext';
 import { ContextError } from './contextError';
-import { RedirectStatus } from '../types/router';
 export declare class ContextRedirectError extends ContextError {
     response: CallbackContextRedirect;
-    constructor(to: unknown[], redirectStatus: RedirectStatus | undefined);
+    constructor(to: unknown[]);
 }

package/dist/errors/unreachableRouteError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * An error thrown when a named route's path does not start with `/`.
+ * Url pathnames always start with `/`, so such a route can never match a url.
+ */
+export declare class UnreachableRouteError extends Error {
+    constructor(name: string, path: string);
+}