useIdle

React sensor hook that tracks if user on the page is idle.

Usage

import { useIdle } from "@reactuses/core";

const Demo = () => {
  const isIdle = useIdle(3e3);

  return (
    <div>
      <div>User is idle: {isIdle ? "Yes 😴" : "Nope"}</div>
    </div>
  );
};

Example

User is idle: Nope

Type Declarations

export default function useIdle(
  ms?: number,
  initialState?: boolean,
  events?: (keyof WindowEventMap)[]
): boolean