R
fn

useClamp

v0.0.1testeddemo

Clamps a value between a minimum and maximum value

Examples

ts
const value = ref(10);
const clampedValue = useClamp(value, 0, 5);
ts
const value = ref(10);
const clampedValue = useClamp(value, () => 0, () => 5);

Demo

Loading demo…

Signature

ts
export function useClamp(value: MaybeRef<number>, min: MaybeRefOrGetter<number>, max: MaybeRefOrGetter<number>): WritableComputedRef<number>;

Parameters

ParameterTypeDescription
valueMaybeRefOrGetter<number>The value to clamp
minMaybeRefOrGetter<number>The minimum value
maxMaybeRefOrGetter<number>The maximum value

Returns

ComputedRef<number>The clamped value