W3cubDocs

/VueUse

useRouteQuery

Category @Router

Export Size 506 B

Package @vueuse/router

Last Changed 2 weeks ago

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

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

Usage

import { useRouteQuery } from '@vueuse/router'

const search = useRouteQuery('search')

const search = useRouteQuery('search', 'foo') // or with a default value

const page = useRouteQuery('page', '1', { transform: Number }) // or transforming value

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

Type Declarations

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

Source

Source • Docs