4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
828 B
828 B
category
| category |
|---|
| @Router |
useRouteParams
Shorthand for a reactive route.params.
Usage
import { useRouteParams } from '@vueuse/router'
const userId = useRouteParams('userId')
const userId = useRouteParams('userId', '-1') // or with a default value
const userId = useRouteParams('page', '1', { transform: Number }) // or transforming value
console.log(userId.value) // route.params.userId
userId.value = '100' // router.replace({ params: { userId: '100' } })
Type Declarations
export declare function useRouteParams(
name: string,
): Ref<null | string | string[]>
export declare function useRouteParams<
T extends RouteParamValueRaw = RouteParamValueRaw,
K = T,
>(
name: string,
defaultValue?: MaybeRefOrGetter<T>,
options?: ReactiveRouteOptionsWithTransform<T, K>,
): Ref<K>