1---
2category: '@Router'
3---
4 
5# useRouteParams
6 
7Shorthand for a reactive `route.params`.
8 
9## Usage
10 
11```ts
12import { useRouteParams } from '@vueuse/router'
13 
14const userId = useRouteParams('userId')
15 
16const userId = useRouteParams('userId', '-1') // or with a default value
17 
18const userId = useRouteParams('page', '1', { transform: Number }) // or transforming value
19 
20console.log(userId.value) // route.params.userId
21userId.value = '100' // router.replace({ params: { userId: '100' } })
22```
23 
24## Type Declarations
25 
26```ts
27export declare function useRouteParams(
28  name: string,
29): Ref<null | string | string[]>
30export declare function useRouteParams<
31  T extends RouteParamValueRaw = RouteParamValueRaw,
32  K = T,
33>(
34  name: string,
35  defaultValue?: MaybeRefOrGetter<T>,
36  options?: ReactiveRouteOptionsWithTransform<T, K>,
37): Ref<K>
38```
39