useRouteParams

Category

@Router

Export Size

496 B

Package

@vueuse/router

Last Changed

last week

对响应式的 route.params 的简写。 Available in the @vueuse/router add-on.

用法

import { useRouteParams } from '@vueuse/router'

const userId = useRouteParams('userId')

const userId = useRouteParams('userId', '-1') // 或者带有默认值

const userId = useRouteParams('page', '1', { transform: Number }) // 或者进行值转换

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>

Source

Source • Docs

Contributors

jorshen

Changelog

No recent changes