Skip to content
On this page

useRouteParams

Shorthand for a reactive route.params.

Available in the @vueuse/router add-on.

Usage

ts
import { useRouteParams } from '@vueuse/router'

const userId = useRouteParams('userId')

const userId = useRouteParams('userId', '-1') // or with a default value

console.log(userId.value) // route.params.userId
userId.value = '100' // router.replace({ params: { userId: '100' } })
import { useRouteParams } from '@vueuse/router'

const userId = useRouteParams('userId')

const userId = useRouteParams('userId', '-1') // or with a default value

console.log(userId.value) // route.params.userId
userId.value = '100' // router.replace({ params: { userId: '100' } })

Type Declarations

typescript
export declare function useRouteParams(
  name: string
): Ref<null | string | string[]>
export declare function useRouteParams<
  T extends null | undefined | string | string[] = null | string | string[]
>(name: string, defaultValue?: T, options?: ReactiveRouteOptions): Ref<T>
export declare function useRouteParams(
  name: string
): Ref<null | string | string[]>
export declare function useRouteParams<
  T extends null | undefined | string | string[] = null | string | string[]
>(name: string, defaultValue?: T, options?: ReactiveRouteOptions): Ref<T>

Source

Category
Export Size
454 B
Package
@vueuse/router
Last Changed
5 months ago

SourceDocs

贡献者(Contributors)

日志(Changelog)

No recent changes

Released under the MIT License.