useRouteQuery

类别

@Router

导出大小

487 B

包

@vueuse/router

最后更改

5 天前

响应式 route.query 的简写。可在 @vueuse/router 附加组件中使用。

用法

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' } })

类型声明

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>

源码

源码 • 文档

贡献者

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 于 2025/3/5

7432f - feat(types): 弃用 MaybeRef 和 MaybeRefOrGetter，改用 Vue 原生方法 (#4636)

v12.3.0 于 2025/1/2

bba3f - feat(router): 支持部分转换 (#4426)

59f75 - feat(toValue): 弃用 @vueuse/shared 中的 toValue，改用 Vue 原生方法

0cc45 - fix: 写入值时区分 undefined 和 null (#4382)

v12.1.0 于 2024/12/22

23fdb - fix(useRouteParams,useRouteQuery): 当 defaultValue 是 ref 或 getter 时，将路由参数/查询设置为 undefined (#3977)

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

0a9ed - feat!: 移除 Vue 2 支持，优化捆绑包并清理代码 (#4349)

v11.3.0 于 2024/11/21

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

44772 - fix(useRouteParams, useRouteQuery): 当对象 getter 作为 watch 源时，effect 触发两次 (#4283)

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

965bf - fix(useRouteHash, useRouteParams, useRouteQuery): 修复 effect 多次触发的问题 (#4113)

v10.8.0 于 2024/2/20

c44fe - fix(useRouteParams,useRouteQuery): 当为 null 或 defaultValue 时，将路由参数/查询设置为 undefined (#3583)

v10.6.0 于 2023/11/9

771e7 - fix(useRouteQuery,useRouteParams): 防止在其他作用域 dispose 时重置 (#3418)

v10.3.0 于 2023/7/30

0d02f - fix(router): 改进路由函数：同步值，添加测试，并优化性能 (#3184)

v10.2.0 于 2023/6/16

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

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

d23ca - feat(useRouteQuery,useRouteParams): 新增 transform 处理程序 (#2191)