useRouteQuery

类别

@Router

导出体积

506 B

依赖包

@vueuse/router

上次更改

7 minutes ago

响应式 route.query 的简写。当 ref 变化时会更新 URL 查询参数。 Available in the @vueuse/router add-on.

用法

import { useRouteQuery } from '@vueuse/router'

const search = useRouteQuery('search')

const search = useRouteQuery('search', 'foo') // 或者带有默认值

const page = useRouteQuery('page', '1', { transform: Number }) // 或者进行值转换

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

Navigation Mode

默认情况下，变更会使用 router.replace()。设置 mode: 'push' 可以改用 router.push()。

import { useRouteQuery } from '@vueuse/router'

const search = useRouteQuery('search', '', { mode: 'push' })

Bidirectional Transform

你可以提供分别用于读取和写入值的 get 和 set 转换函数。

import { useRouteQuery } from '@vueuse/router'

const filters = useRouteQuery('filters', [], {
  transform: {
    get: v => v ? v.split(',') : [],
    set: v => v.join(','),
  },
})

// 读取时: 'a,b,c' -> ['a', 'b', 'c']
// 写入时: ['a', 'b', 'c'] -> 'a,b,c'

Default Value Behavior

当值等于默认值时，查询参数会从 URL 中移除。

import { useRouteQuery } from '@vueuse/router'

const page = useRouteQuery('page', '1')

page.value = '2' // URL: ?page=2
page.value = '1' // URL: (无 page 参数，因为等于默认值)

类型声明

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>

源码

源码 • 文档

贡献者

一纸忘忧

更新日志

没有最近的更新日志