useRouteParams

類別

@Router

導出大小

496 B

套件

@vueuse/router

最後變更

5 天前

響應式 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

Anthony Fu

Antério Vieira

IlyaL

alexchexes

Stefan Vojvodic

Guillaume Chau

jack-allocate

Lindsay Gaines

huiliangShen

Manoah Tervoort

Shean de Montigny-Desautels

Eduardo Wesley

Dvir Hazout

Curt Grimes

DevilTea

更新日誌

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 原生功能

v12.1.0 於 2024/12/22

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

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

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

v11.3.0 於 2024/11/21

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

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

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

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

v10.10.0 於 2024/5/27

4a882 - fix: 支援可選參數 (#3934)

v10.8.0 於 2024/2/20

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

v10.6.0 於 2023/11/9

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

v10.3.0 於 2023/7/30

0d02f - fix(router): 改善 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)