Tiny Javascript library to track browser idle status. (callback when user is idle).
IE / Edge |
Firefox |
Chrome |
Safari |
iOS Safari |
Samsung |
Opera |
|---|---|---|---|---|---|---|
| Edge | last version | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
via yarn
$ yarn add idle-tracker
or via npm
$ npm install idle-tracker
import IdleTracker from 'idle-tracker';
const idleTracker = new IdleTracker(options);
idleTracker.start(); // start tracker
idleTracker.end(); // stop tracker and release memory| Options Name | Type | Default | Description |
|---|---|---|---|
| timeout (ms) | number | 30000 | timeout to count as idle |
| onIdleCallback | Function | noop | Function to be called when idle status change, payload will be { idle: true/false }, with optional event payload |
| throttle | number | 500 | throttle rate of callback |
- Browser might support this function natively in the future, see Idle Detection API
- Related newer API/Library: page-lifecycle, repo