useIdle

v0.0.14testeddemo

Track whether the user has been inactive for a given duration.

Examples

const { idle, lastActive, reset } = useIdle(5 * 60_000); // 5 minutes

const { idle } = useIdle(10_000, { events: ['keydown'] });

Loading demo…

export function useIdle(
  timeout: number = ONE_MINUTE,
  options: UseIdleOptions ={ ... }

Parameter	Type	Default	Description
`timeout`?	`number`	`ONE_MINUTE`	Idle threshold in milliseconds
`options`?	`UseIdleOptions`	`{}`	Options

UseIdleReturn{ idle, lastActive, isPending, reset, start, stop }

Property	Type	Default	Description
`idle`	`ShallowRef<boolean>`	—	Whether the user is currently idle
`lastActive`	`ShallowRef<number>`	—	Timestamp (ms) of the last detected user activity
`isPending`	`Readonly<ShallowRef<boolean>>`	—	Whether the idle tracker is currently running
`reset`	`() => void`	—	Manually mark the user as active and restart the idle timer
`start`	`() => void`	—	Begin (or resume) tracking. Restarts the idle timer unless `initialState` is `true`
`stop`	`() => void`	—	Stop tracking. Resets `idle` to `initialState` and clears the pending timer