fn
useIdle
v0.0.15testeddemoTrack whether the user has been inactive for a given duration.
Examples
ts
const { idle, lastActive, reset } = useIdle(5 * 60_000); // 5 minutests
const { idle } = useIdle(10_000, { events: ['keydown'] });Demo
Loading demo…
Signature
ts
export function useIdle(
timeout: number = ONE_MINUTE,
options: UseIdleOptions ={ ... }Parameters
| Parameter | Type | Description |
|---|---|---|
timeout? | number | Idle threshold in milliseconds |
options? | UseIdleOptions | Options |
Returns
UseIdleReturn`{ idle, lastActive, isPending, reset, start, stop }`