⬅️ Back to Table of Contents

📄 useClamp

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	9
🟢 Vue Composition API	2

📚 Table of Contents

• Imports
• Vue Composition API
• Functions

🛠️ File Location:

📂 packages/math/useClamp/index.ts

📦 Imports

Name	Source
ReadonlyRefOrGetter	@vueuse/shared
ComputedRef	vue
MaybeRefOrGetter	vue
Ref	vue
clamp	@vueuse/shared
computed	vue
deepRef	vue
isReadonly	vue
toValue	vue

---

Vue Composition API

Name	Type	Reactive Variables	Composables
computed	computed	none	none
computed	computed	none	none

---

Functions

useClamp(value: ReadonlyRefOrGetter<number>, min: MaybeRefOrGetter<number>, max: MaybeRefOrGetter<number>): ComputedRef<number>

Reactively clamp a value between two other values.

Parameters:

• value any: number
• min any: No description
• max any: No description

See: https://vueuse.org/useClamp

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc

/**
 * Reactively clamp a value between two other values.
 *
 * @see https://vueuse.org/useClamp
 * @param value number
 * @param min
 * @param max
 *
 * @__NO_SIDE_EFFECTS__
 */

Code

export function useClamp(
  value: ReadonlyRefOrGetter<number>,
  min: MaybeRefOrGetter<number>,
  max: MaybeRefOrGetter<number>,
): ComputedRef<number>

---

Generated by Syntax Scribe