useRouteParams

反应式 route.params 的简写。

¥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' } })

类型声明

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>

源代码

源代码 • 文档

变更日志

v12.3.0 on 1/2/2025

bba3f - feat(router): support partial transform (#4426)

59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native

v12.1.0 on 12/22/2024

23fdb - fix(useRouteParams,useRouteQuery): set route param/query to undefined when defaultValue is ref or getter (#3977)