useRouteQuery

Category

@Router

Export Size

487 B

Package

@vueuse/router

Last Changed

3 hours ago

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

用法

import { useRouteQuery } from '@vueuse/router'

const search = useRouteQuery('search')

const search = useRouteQuery('search', 'foo') // 或者带有默认值

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

console.log(search.value) // route.query.search
search.value = 'foobar' // router.replace({ query: { search: 'foobar' } })

Type Declarations

export declare function useRouteQuery(
  name: string,
): Ref<undefined | null | string | string[]>
export declare function useRouteQuery<
  T extends RouteQueryValueRaw = RouteQueryValueRaw,
  K = T,
>(
  name: string,
  defaultValue?: MaybeRefOrGetter<T>,
  options?: ReactiveRouteOptionsWithTransform<T, K>,
): Ref<K>

Source

Source • Docs

Contributors

jorshen

Changelog

No recent changes