useRouteQuery

カテゴリ

@Router

エクスポートサイズ

607 バイト

パッケージ

@vueuse/router

最終変更日

先週

リアクティブな `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<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

Antério Vieira

Guillaume Chau

jack-allocate

Anthony Fu

Lindsay Gaines

Manoah Tervoort

Shean de Montigny-Desautels

Eduardo Wesley

wheat

Dvir Hazout

Curt Grimes

Sacha STAFYNIAK

reslear

Marshall Thompson

変更履歴

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): オブジェクトゲッターを watch ソースとして使用すると、エフェクトが 2 回トリガーされる (#4283)

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

965bf - useRouteHash、useRouteParams、useRouteQuery の修正: エフェクトが複数回トリガーされる問題の修正 (#4113)

v10.8.0 2024/2/20

c44fe - useRouteParams、useRouteQuery の修正: null または defaultValue の場合、ルートパラメータ/クエリを undefined に設定する (#3583)

v10.6.0 2023/11/9

771e7 - useRouteQuery、useRouteParams の修正: 他のスコープの破棄時にリセットされないようにする (#3418)

v10.3.0 2023/7/30

0d02f - ルーターの修正: ルーター関数の改善: 値の同期、テストの追加、パフォーマンスの最適化 (#3184)

v10.2.0 2023/6/16

d5252 - useRouteHash、useRouteQuery、useRouteParams の修正: 値を即時に再評価する (#3002)

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

d23ca - useRouteQuery、useRouteParams の機能追加: 新しい `transform` ハンドラ (#2191)

v9.11.0 2023/1/17

07c95 - 修正: 同じティックで複数のルートクエリを設定できるようにする (#2646)

v9.4.0 2022/10/25

be36a - useRouteHash、useRouteParams、useRouteQuery の修正: 選択したルートパラメータのみを上書きする (#2350)