fn
useTimeout
v0.0.14testeddemoReactive boolean that flips to true after a given delay.
Built on useTimeoutFn; optionally exposes start/stop controls. SSR-safe.
Examples
ts
const ready = useTimeout(1000);
// `ready.value` becomes true after 1sts
const { ready, start, stop } = useTimeout(1000, { controls: true });ts
// Run a callback when the timeout elapses
useTimeout(5000, { callback: refresh });Demo
Loading demo…
Signatures
ts
export function useTimeout(interval?: MaybeRefOrGetter<number>, options?: UseTimeoutOptions<false>): ComputedRef<boolean>;ts
export function useTimeout(interval: MaybeRefOrGetter<number>, options: UseTimeoutOptions<true>): UseTimeoutControls;Parameters
| Parameter | Type | Description |
|---|---|---|
interval? | MaybeRefOrGetter<number> | Delay in milliseconds (resolved each time the timeout starts, can be reactive) |
options? | UseTimeoutOptions<boolean> | Options |
Returns
UseTimeoutReturnThe read-only ready flag, or controls when controls: true