跳到主要内容

useRouteParams

分类
导出大小
518 B
@vueuse/router
上次更改
8 个月前

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

用法

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

类型声明

ts
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
吉约姆·肖
jack-allocate
Lindsay Gaines
huiliangShen
Manoah Tervoort
Shean de Montigny-Desautels
Eduardo Wesley
Dvir Hazout
Curt Grimes
DevilTea

更新日志

v12.8.0
7432f - feat(types): 废弃 MaybeRefMaybeRefOrGetter,转而使用 Vue 的原生类型 (#4636)
v12.3.0
bba3f - feat(router): 支持部分转换 (#4426)
59f75 - feat(toValue): 废弃 @vueuse/shared 中的 toValue,转而使用 Vue 的原生函数
v12.1.0
23fdb - fix(useRouteParams,useRouteQuery): 当 defaultValue 是 ref 或 getter 时,将路由参数/查询设置为 undefined (#3977)
0a9ed - feat!: 放弃对 Vue 2 的支持,优化打包并清理 (#4349)
v11.3.0
65aa0 - feat(router): 转换 get / set (#4326)
44772 - fix(useRouteParams, useRouteQuery): 当使用对象 getter 作为 watch 源时,effect 会触发两次 (#4283)
965bf - fix(useRouteHash, useRouteParams, useRouteQuery): 修复 effect 多次触发的问题 (#4113)
4a882 - fix: 支持可选参数 (#3934)
v10.8.0
c44fe - fix(useRouteParams,useRouteQuery): 当为 null 或 defaultValue 时,将路由参数/查询设置为 undefined (#3583)
v10.6.0
771e7 - fix(useRouteQuery,useRouteParams): 防止在其他作用域销毁时重置 (#3418)
v10.3.0
0d02f - fix(router): 改进路由函数:同步值,添加测试,并优化性能 (#3184)
v10.2.0
d5252 - fix(useRouteHash,useRouteQuery,useRouteParams): 立即重新评估值 (#3002)

根据 MIT 许可证发布。