useRouteQuery

Category

@Router

Export Size

506 B

Package

@vueuse/router

Last Changed

6 months 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<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

Anthony Fu

Anthony Fu

Antério Vieira

IlyaL

alexchexes

Andrej Agapow

Stefan Vojvodic

Guillaume Chau

jack-allocate

Lindsay Gaines

Manoah Tervoort

Shean de Montigny-Desautels

Eduardo Wesley

wheat

Dvir Hazout

Curt Grimes

Sacha STAFYNIAK

reslear

Marshall Thompson

Changelog

v12.8.0 on 3/5/2025

7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)

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

0cc45 - fix: differentiate undefined and null when writing value (#4382)

v12.1.0 on 12/22/2024

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

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)

v11.3.0 on 11/21/2024

65aa0 - feat(router): transform get / set (#4326)

44772 - fix(useRouteParams, useRouteQuery): effect triggers twice with object getter as watch source (#4283)

v11.0.0-beta.3 on 8/14/2024

965bf - fix(useRouteHash, useRouteParams, useRouteQuery): fix effect triggering multiple times (#4113)

v10.8.0 on 2/20/2024

c44fe - fix(useRouteParams,useRouteQuery): set route param/query to undefined when null or defaultValue (#3583)

v10.6.0 on 11/9/2023

771e7 - fix(useRouteQuery,useRouteParams): prevent reset on other scope dispose (#3418)

v10.3.0 on 7/30/2023

0d02f - fix(router): improves router functions: synchronize values, adds tests, and optimize performance (#3184)

v10.2.0 on 6/16/2023

d5252 - fix(useRouteHash,useRouteQuery,useRouteParams): re-evaluates the value immediately (#3002)

v10.0.0-beta.4 on 4/13/2023

d23ca - feat(useRouteQuery,useRouteParams): new transform handler (#2191)