Skip to content
On this page

useClamp

Reactively clamp a value between two other values.

例子

min: max: value:0

Usage

ts
import { useClamp } from '@vueuse/math'

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

const min = ref(0)
const max = ref(10)
const value = useClamp(0, min, max)

You can also pass a ref and the returned computed will be updated when the source ref changes:

ts
import { useClamp } from '@vueuse/math'

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

const number = ref(0)
const clamped = useClamp(number, 0, 10)

Type Declarations

typescript
export declare function useClamp(
  value: MaybeReadonlyRef<number>,
  min: MaybeComputedRef<number>,
  max: MaybeComputedRef<number>
): ComputedRef<number>
export declare function useClamp(
  value: MaybeRef<number>,
  min: MaybeComputedRef<number>,
  max: MaybeComputedRef<number>
): Ref<number>
export declare function useClamp(
  value: MaybeReadonlyRef<number>,
  min: MaybeComputedRef<number>,
  max: MaybeComputedRef<number>
): ComputedRef<number>
export declare function useClamp(
  value: MaybeRef<number>,
  min: MaybeComputedRef<number>,
  max: MaybeComputedRef<number>
): Ref<number>

Source

Category
Export Size
259 B
Package
@vueuse/math
Last Changed
last month

SourceDemoDocs

贡献者(Contributors)

日志(Changelog)

v9.13.0 on 2023/2/18
08a07 - feat: composable computed usage improvements (#2696)

Released under the MIT License.