useRouteParams

カテゴリ

@Router

エクスポートサイズ

612 B

パッケージ

@vueuse/router

最終更新日

先週

リアクティブなroute.paramsの省略形です。@vueuse/routerアドオンで使用できます。

使用方法

import { useRouteParams } from '@vueuse/router'

const userId = useRouteParams('userId')

const userId = useRouteParams('userId', '-1') // or with a default value

const userId = useRouteParams('page', '1', { transform: Number }) // or transforming value

console.log(userId.value) // route.params.userId
userId.value = '100' // router.replace({ params: { userId: '100' } })

型宣言

export declare function useRouteParams(
  name: string,
): Ref<null | string | string[]>
export declare function useRouteParams<
  T extends RouteParamValueRaw = RouteParamValueRaw,
  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

huiliangShen

Manoah Tervoort

Shean de Montigny-Desautels

Eduardo Wesley

Dvir Hazout

Curt Grimes

DevilTea

変更ログ

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): オブジェクトゲッターを監視ソースとして使用した場合、効果が2回トリガーされる問題を修正 (#4283)

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

965bf - fix(useRouteHash, useRouteParams, useRouteQuery): 効果が複数回トリガーされる問題を修正 (#4113)

v10.10.0 2024/5/27

4a882 - fix: オプションのパラメーターをサポート (#3934)

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 - 修正(router): ルーター関数の改善: 値の同期、テストの追加、パフォーマンスの最適化 (#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.4.0 2022年10月25日

be36a - 修正(useRouteHash, useRouteParams, useRouteQuery): 選択されたルートパラメータのみ上書き (#2350)