Socket
Socket
Sign inDemoInstall

idle-js

Package Overview
Dependencies
3
Maintainers
2
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    idle-js

Detect user idleness


Version published
Maintainers
2
Install size
3.08 MB
Created

Readme

Source

idle-js

js-standard-style

npm install idle-js --save

Usage

// Those are the default values
var idle = new IdleJs({
  idle: 10000, // idle time in ms
  events: ['mousemove', 'keydown', 'mousedown', 'touchstart'], // events that will trigger the idle resetter
  onIdle: function () {}, // callback function to be executed after idle time
  onActive: function () {}, // callback function to be executed after back form idleness
  onHide: function () {}, // callback function to be executed when window become hidden
  onShow: function () {}, // callback function to be executed when window become visible
  keepTracking: true, // set it to false if you want to be notified only on the first idleness change
  startAtIdle: false // set it to true if you want to start in the idle state
});
idle.start();

// In case stopping is needed
idle.stop()   // stops all tracking
    .reset()  // reset visible and idle state to initial values
    .start();

// Reset to a specific state
idle.reset({
  idle: false,
  visible: ! document.hidden,
})

Running examples

Webpack:
  • Run the command npx webpack ./example/webpack/entry.js ./example/webpack/bundle.js.
  • Open ./example/webpack/index.html in your browser.
In browser:
  • Open ./example/vanilla/index.html

Keywords

FAQs

Last updated on 13 May 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc