All hooks / Page, device, and user

useIdle

238 B minified and brotliedSourceMarkdown✓ Works in all modern browsers

Whether the user has been inactive (no pointer, keyboard, touch, wheel, or scroll input) for timeoutMs. Becomes false again on the next activity.

false on the server, during hydration, and on mount: a user who just loaded the page counts as active. Activity only records a timestamp, and a single timer checks it, so mouse movement does not re-render.

Import

import { useIdle } from '@vincent.ri/react-tils'
// or only this hook
import { useIdle } from '@vincent.ri/react-tils/useIdle'

Usage

const idle = useIdle(5 * 60_000)
return idle ? <Dialog>Are you still there?</Dialog> : null

Live demo

When to use it

Showing "Are you still there?" before a session timeout, pausing expensive live updates, or setting a chat status to "away".

When not to

You mean "the tab is hidden"; use useDocumentVisibility. Activity inside an <iframe> (an embedded video or payment form) isn't seen, so a user busy there can turn idle. Don't use it alone to log users out for security; enforce session expiry on the server.

API

function useIdle(timeoutMs?: number): boolean