Idle Manager Js

Idle Manager Js is a library for tracking user activity. It allows you to detect when a user becomes inactive and react to user activity, which can be useful for applications that require auto-session termination or timeout actions.

Installation

To install the library, execute one of the commands:

npm install idle-manager-js

yarn add idle-manager-js

pnpm add idle-manager-js

Usage

Basic Example

import IdleManager from 'idle-manager-js';

const idleManager = new IdleManager({
  idleTime: 300000, // Time of inactivity in milliseconds (e.g., 5 minutes)
  onIdle: () => {
    console.log('User is idle');
    // Perform actions when the user is idle (e.g., log out or end session)
  },
  onActive: () => {
    console.log('User is active');
    // Perform actions when the user becomes active again (e.g., restore session)
  },
});

idleManager.start(); // Starts tracking user activity

Configuration

• idleTime (optional):
  The time of inactivity in milliseconds after which the user is considered idle.
  Default: 60000 milliseconds (1 minute)

• onIdle (required):
  A callback function that will be triggered when the user becomes idle.

• onActive (required):
  A callback function that will be triggered when the user becomes active again.

• events (optional):
  An array of event types to listen for user activity. Default: ['mousemove', 'keydown', 'mousedown', 'touchstart', 'touchmove', 'visibilitychange', 'scroll', 'resize']

  • mousemove Any movement of the mouse indicates user activity.
  • keydown Pressing keys on the keyboard, for example, when the user is typing text.
  • mousedown Pressing the mouse button, which often occurs when interacting with elements.
  • touchstart The start of a touch event on mobile devices.
  • touchmove Movement of a finger on a mobile device's screen.
  • visibilitychange The visibility change of the page (e.g., switching tabs).
  • scroll Scrolling the page or an element, which is a clear sign of user activity.
  • resize Changing the browser window size (sometimes used to track activity).

Methods

start()

Starts tracking user activity. Begins listening for activity events and resets the timer on each event.

stop()

Stops tracking user activity. Removes all event listeners and clears the timer.

resetTimer()

Automatically resets the timer whenever an activity event (e.g., mouse movement or key press) occurs. If the page loses focus, the user is considered idle.

triggerIdle()

Triggers the idle timeout, marking the user as idle.

License

This project is licensed under the MIT License.

Support the Project 💖

If you find idle-manager-js useful and want to support its development, consider making a donation:

Contributing

We welcome contributions! If you have ideas, improvements, or fixes — please feel free to create a Pull Request or open an Issue.