react-activity-detector/index.d.ts

React Activity Detector. Detects if the user is active or idle, also includes Cross-Tab functionality

declare module "react-activity-detector" {
  import React from "react";

  type ActivityEvent =
    | "click"
    | "mousemove"
    | "keydown"
    | "DOMMouseScroll"
    | "mousewheel"
    | "mousedown"
    | "touchstart"
    | "touchmove"
    | "focus";

  export interface ActivityDetectorProps {
    /**
     * Array of possible events that trigger user activity
     * Defaults to all events
     */
    activityEvents?: ActivityEvent[];
    /**
     * Time in milliseconds before user is considered idle
     * Defaults to 300000 (5 minutes)
     */
    timeout?: number;
    /**
     * Whether to start the detector in an idle state
     * Defaults to false
     */
    enabled?: boolean;
    /**
     * Set a unique id for the detector to allow for multiple detectors
     */
    name?: string;
    /** Event that triggers when user is declared idle */
    onIdle?: () => void;
    /** Event that triggers when user is declared active */
    onActive?: () => void;
  }

  const ActivityDetector: React.FC<ActivityDetectorProps>;
  export default ActivityDetector;
}