useRouteQuery ​
Shorthand for a reactive route.query
. Available in the @vueuse/router add-on.
Usage ​
ts
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 ​
typescript
export declare function useRouteQuery(
name: string,
): Ref<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 ​
Contributors ​
Anthony Fu
Antério Vieira
Manoah Tervoort
Shean de Montigny-Desautels
Eduardo Wesley
wheat
Dvir Hazout
Curt Grimes
Sacha STAFYNIAK
reslear
Marshall Thompson
Changelog ​
v10.8.0
on 2/20/2024c44fe
- fix(useRouteParams,useRouteQuery): set route param/query to undefined when null or defaultValue (#3583)v10.6.0
on 11/9/2023v10.3.0
on 7/30/20230d02f
- fix(router): improves router functions: synchronize values, adds tests, and optimize performance (#3184)v10.2.0
on 6/16/2023v10.0.0-beta.4
on 4/13/2023v9.11.0
on 1/17/2023v9.4.0
on 10/25/2022