Skip to content
On this page

useClamp

Category
Export Size
259 B
Package
@vueuse/math
Last Changed
2 months ago

Reactively clamp a value between two other values.

Demo

min: max: value:0

Usage

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)

Type Declarations

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

Source

SourceDemoDocs

Contributors

Anthony Fu
Jelf

Changelog

v8.9.2 on 7/12/2022
27125 - feat(math)!: move useClamp to @vueuse/math (#1810)
v8.9.1 on 7/8/2022
a9ccc - feat(all): use MaybeComputedRef (#1768)
v7.1.0 on 11/24/2021
e6659 - feat: new function (#953)

Released under the MIT License.