useRouteQuery

Category

@Router

匯出大小

487 B

Package

@vueuse/router

Last Changed

5 days 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

更新日誌

v12.8.0 on 2025/3/5

7432f - feat(types): 棄用 MaybeRef 和 MaybeRefOrGetter，改用 Vue 原生型別 (#4636)

v12.3.0 on 2025/1/2

bba3f - feat(router): 支援部分轉換 (#4426)

59f75 - feat(toValue): 棄用 toValue 從 @vueuse/shared，改用 Vue 原生型別

0cc45 - fix: 寫入值時區分 undefined 和 null (#4382)

v12.1.0 on 2024/12/22

23fdb - fix(useRouteParams,useRouteQuery): 當 defaultValue 是 ref 或 getter 時，將 route param/query 設定為 undefined (#3977)

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

0a9ed - feat!: 移除 Vue 2 支援，優化 bundle 並清理程式碼 (#4349)

v11.3.0 on 2024/11/21

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

44772 - fix(useRouteParams, useRouteQuery): 使用物件 getter 作為監看來源時，effect 觸發兩次 (#4283)

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

965bf - fix(useRouteHash, useRouteParams, useRouteQuery): 修復 effect 多次觸發的問題 (#4113)

v10.8.0 on 2024/2/20

c44fe - fix(useRouteParams,useRouteQuery): 當 null 或 defaultValue 時，將 route param/query 設定為 undefined (#3583)

v10.6.0 on 2023/11/9

771e7 - fix(useRouteQuery,useRouteParams): 防止在其他 scope dispose 時重置 (#3418)

v10.3.0 on 2023/7/30

0d02f - fix(router): 改善路由函式：同步數值、新增測試並優化效能 (#3184)

v10.2.0 on 2023/6/16

d5252 - fix(useRouteHash,useRouteQuery,useRouteParams): 立即重新評估數值 (#3002)

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

d23ca - feat(useRouteQuery,useRouteParams): 新增 transform 處理器 (#2191)