W3cubDocs

/VueUse

useRouteParams

Category @Router

Export Size 473 B

Package @vueuse/router

Last Changed 2 weeks ago

Category	@Router
Export Size	473 B
Package	`@vueuse/router`
Last Changed	2 weeks ago

Shorthand for a reactive route.params. Available in the @vueuse/router add-on.

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 RouterQueryValue = RouterQueryValue,
  K = T
>(
  name: string,
  defaultValue?: T,
  options?: ReactiveRouteOptionsWithTransform<T, K>
): Ref<K>

Source

Source • Docs