@flightdev/router 0.4.0

package/dist/vue/index.d.ts

@@ -0,0 +1,147 @@
+import { P as PrefetchStrategy, b as RouterProviderProps, a as RouterContextValue } from '../prefetch-DRp54Q7z.js';
+export { L as LinkProps, N as NavigateOptions, d as PrefetchOptions, c as PrefetchPriority, R as RouteParams, S as SearchParams, w as clearPrefetchCache, l as findRoute, o as generatePath, B as getRouterContext, D as initRouter, q as isActive, v as isPrefetched, m as matchRoute, n as navigate, x as observeForPrefetch, p as parseParams, s as prefetch, t as prefetchAll, z as prefetchPages, A as prefetchWhenIdle, r as redirect, y as setupIntentPrefetch, C as subscribe } from '../prefetch-DRp54Q7z.js';
+import * as vue from 'vue';
+import { PropType, Ref } from 'vue';
+
+/**
+ * Vue Link Component
+ *
+ * @example
+ * ```vue
+ * <template>
+ *     <Link href="/docs" prefetch="intent">Documentation</Link>
+ * </template>
+ * ```
+ */
+declare const Link: vue.DefineComponent<vue.ExtractPropTypes<{
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+    prefetch: {
+        type: PropType<boolean | PrefetchStrategy>;
+        default: string;
+    };
+    replace: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    scroll: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    target: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    rel: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    href: {
+        type: StringConstructor;
+        required: true;
+    };
+    prefetch: {
+        type: PropType<boolean | PrefetchStrategy>;
+        default: string;
+    };
+    replace: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    scroll: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    class: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    target: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    rel: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    replace: boolean;
+    scroll: boolean;
+    prefetch: boolean | PrefetchStrategy;
+    class: string;
+    target: string;
+    rel: string;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+/**
+ * Vue Composables for Router
+ *
+ * Provides Vue 3 composition API composables for routing.
+ */
+
+/**
+ * Vue RouterProvider component for composition API
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { RouterProvider } from '@flightdev/router/vue';
+ * </script>
+ *
+ * <template>
+ *     <RouterProvider initial-path="/">
+ *         <App />
+ *     </RouterProvider>
+ * </template>
+ * ```
+ */
+declare function RouterProvider(props: RouterProviderProps, { slots }: {
+    slots: {
+        default?: () => unknown;
+    };
+}): unknown;
+/**
+ * Composable to access router functions
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { useRouter } from '@flightdev/router/vue';
+ *
+ * const { navigate, back, forward } = useRouter();
+ * </script>
+ * ```
+ */
+declare function useRouter(): RouterContextValue;
+/**
+ * Composable to get current pathname
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * import { usePathname } from '@flightdev/router/vue';
+ *
+ * const pathname = usePathname();
+ * </script>
+ * ```
+ */
+declare function usePathname(): Ref<string>;
+/**
+ * Composable to get current search params
+ */
+declare function useSearchParams(): Ref<URLSearchParams>;
+/**
+ * Composable to get route params
+ */
+declare function useParams(): Ref<Record<string, string>>;
+
+export { Link, PrefetchStrategy, RouterContextValue, RouterProvider, RouterProviderProps, useParams, usePathname, useRouter, useSearchParams };