项目作者: roderickhsiao

项目描述 :
Javascript library to track browser inactivity
高级语言: JavaScript
项目地址: git://github.com/roderickhsiao/idle-tracker.git
创建时间: 2019-02-05T07:17:43Z
项目社区:https://github.com/roderickhsiao/idle-tracker

开源协议:MIT License

下载



Idle Tracker


idle tracker


npm
gzip size
downloads


Tiny Javascript library to track browser idle status. (callback when user is idle).

Demo

Browsers support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
iOS Safari
iOS Safari
Samsung
Samsung
Opera
Opera
Edge last version last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions

Installation

via yarn

  1. $ yarn add idle-tracker

or via npm

  1. $ npm install idle-tracker

Usage

  1. import IdleTracker from 'idle-tracker';
  2. const idleTracker = new IdleTracker(options);
  3. idleTracker.start(); // start tracker
  4. idleTracker.end(); // stop tracker and release memory

Constructor options

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

Future

  1. Browser might support this function natively in the future, see Idle Detection API
  2. Related newer API/Library: page-lifecycle, repo