Skip to content

useClamp

类别
导出体积
223 B
依赖包
@vueuse/math
上次更改
2 months ago

在两个其他值之间响应式地夹取一个值。

示例

min: max: value:0

用法

ts
import { 
useClamp
} from '@vueuse/math'
const
min
=
shallowRef
(0)
const
max
=
shallowRef
(10)
const
value
=
useClamp
(0,
min
,
max
)

你也可以传递一个 ref,当源 ref 发生变化时,返回的 computed 将会被更新:

ts
import { 
useClamp
} from '@vueuse/math'
const
number
=
shallowRef
(0)
const
clamped
=
useClamp
(
number
, 0, 10)

类型声明

ts
/**
 * Reactively clamp a value between two other values.
 *
 * @see https://vueuse.org/useClamp
 * @param value number
 * @param min
 * @param max
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function 
useClamp
(
value
:
ReadonlyRefOrGetter
<number>,
min
:
MaybeRefOrGetter
<number>,
max
:
MaybeRefOrGetter
<number>,
):
ComputedRef
<number>
export declare function
useClamp
(
value
:
MaybeRefOrGetter
<number>,
min
:
MaybeRefOrGetter
<number>,
max
:
MaybeRefOrGetter
<number>,
):
Ref
<number>

源码

源码演示文档

贡献者

Anthony Fu
一纸忘忧
Anthony Fu
IlyaL
SerKo
ClemDee

更新日志

d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)
7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)