@kitbag/router 0.20.1 → 0.20.3

package/dist/kitbag-router.d.ts

@@ -13,33 +13,6 @@ import { StandardSchemaV1 } from '@standard-schema/spec';
 import { UnwrapRef } from 'vue';
 import { VNode } from 'vue';
 
-declare const __VLS_component: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
-
-declare type __VLS_Props = {
-    name?: string;
-};
-
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: Readonly<{
-        default?: (props: {
-            route: RouterRoute;
-            component: Component;
-            rejection: UnwrapRef<RouterRejection>;
-        }) => VNode;
-    }> & {
-        default?: (props: {
-            route: RouterRoute;
-            component: Component;
-            rejection: UnwrapRef<RouterRejection>;
-        }) => VNode;
-    };
-    refs: {};
-    rootEl: any;
-};
-
-declare type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
@@ -434,6 +407,7 @@ declare type GetParentPropsReturnType<TParent extends Route | undefined = Route
 
 /**
  * @deprecated use `withParams` instead
+ * @hidden we don't want to expose this in the api docs
  */
 export declare const host: typeof withParams;
 
@@ -618,6 +592,7 @@ declare type ParamWithDefault<TParam extends Param = Param> = Required<ParamGetS
 
 /**
  * @deprecated use `withParams` instead
+ * @hidden we don't want to expose this in the api docs
  */
 export declare const path: typeof withParams;
 
@@ -668,6 +643,7 @@ declare type PropsGetter<TOptions extends CreateRouteOptions = CreateRouteOption
 
 /**
  * @deprecated use `withParams` instead
+ * @hidden we don't want to expose this in the api docs
  */
 export declare const query: typeof withParams;
 
@@ -985,6 +961,10 @@ export declare type Router<TRoutes extends Routes = any, TOptions extends Router
      * Initializes the router based on the initial route. Automatically called when the router is installed. Calling this more than once has no effect.
      */
     start: () => Promise<void>;
+    /**
+     * Returns true if the router has been started.
+     */
+    started: Ref<boolean>;
     /**
      * Stops the router and teardown any listeners.
      */
@@ -993,6 +973,9 @@ export declare type Router<TRoutes extends Routes = any, TOptions extends Router
 
 declare type RouterHistoryMode = 'auto' | 'browser' | 'memory' | 'hash';
 
+/**
+ * @hidden we don't want the criptic component types showing up in the api docs
+ */
 export declare const RouterLink: __VLS_WithTemplateSlots_2<DefineComponent<    {
 /**
 * The url string to navigate to or a callback that returns a url string
@@ -1020,6 +1003,8 @@ element: HTMLAnchorElement;
         route: ResolvedRoute | undefined;
         isMatch: boolean;
         isExactMatch: boolean;
+        isActive: boolean;
+        isExactActive: boolean;
         isExternal: boolean;
     }) => unknown;
 }> & {
@@ -1027,6 +1012,8 @@ element: HTMLAnchorElement;
         route: ResolvedRoute | undefined;
         isMatch: boolean;
         isExactMatch: boolean;
+        isActive: boolean;
+        isExactActive: boolean;
         isExternal: boolean;
     }) => unknown;
 }>;
@@ -1160,7 +1147,26 @@ export declare type RouterRoutes<TRoutes extends Routes> = {
     [K in keyof TRoutes]: RouterRoute<ResolvedRoute<TRoutes[K]>>;
 }[number];
 
-export declare const RouterView: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+/**
+ * @hidden we don't want the criptic component types showing up in the api docs
+ */
+export declare const RouterView: __VLS_WithTemplateSlots<DefineComponent<    {
+name?: string;
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{
+name?: string;
+}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, Readonly<{
+    default?: (props: {
+        route: RouterRoute;
+        component: Component;
+        rejection: UnwrapRef<RouterRejection>;
+    }) => VNode;
+}> & {
+    default?: (props: {
+        route: RouterRoute;
+        component: Component;
+        rejection: UnwrapRef<RouterRejection>;
+    }) => VNode;
+}>;
 
 /**
  * Represents an immutable array of Route instances. Return value of `createRoute`, expected param for `createRouter`.
@@ -1256,6 +1262,14 @@ export declare type UseLink = {
      * True if route matches current URL. Route is the same as what's currently stored at `router.route`.
      */
     isExactMatch: ComputedRef<boolean>;
+    /**
+     * True if route matches current URL, or is a parent route that matches the parent of the current URL.
+     */
+    isActive: ComputedRef<boolean>;
+    /**
+     * True if route matches current URL exactly.
+     */
+    isExactActive: ComputedRef<boolean>;
     /**
      *
      */