refThrottled

v0.0.14testeddemo

A ref whose value updates are throttled. The returned ref mirrors the source but propagates changes at most once per delay window, making it useful for rate-limiting reactive updates driven by high-frequency events such as scroll or resize.

Source Tests

Examples

const input = ref('');
const throttled = refThrottled(input, 1000);

const scrollY = ref(0);
const throttledY = refThrottled(scrollY, 100, true, false);

Demo

Loading demo…

Signature

export function refThrottled<T = unknown>(
  source: MaybeRefOrGetter<T>,
  delay = 200,
  trailing = true,
  leading = true,
): RefThrottledReturn<T>{ ... }

Type Parameters

T= unknown

Parameters

Parameter	Type	Default	Description
`source`	`MaybeRefOrGetter<T>`	—	The ref, getter, or value to watch and throttle
`delay`?	`number`	`200`	A zero-or-greater delay in milliseconds; values around 100–250 (or higher) are most useful
`trailing`?	`boolean`	`true`	Update the value again on the trailing edge after the window elapses
`leading`?	`boolean`	`true`	Update the value on the leading edge of the window

Returns

RefThrottledReturn<T>A ref reflecting the throttled source value