Git Product home page Git Product logo

multitab_idle_timer's Introduction

Multi Tabs IdleTimer

Mutli Tabs idle Timer of Single Page Application

npm, Webpack, Bable, Karma, Chai, Sinon

Installation

npm install --save multitab_idle_timer

API

import {IdleTimer} from 'multitab_idle_timer'
const idleTimer = new IdleTimer({timeout: 5, warnBefore: 1, store: 'session' }); 
/* 
 timeout: in 5 minutes, 
 warnBefore: 1 minute,  It will trigger warn event one minute before expiration
 store: local | session, default is local
*/

idleTimer.init();// initialize timer 

idleTimer.on('active', (idleTimerObject)=>{
    //do some thing when page is active
});

idleTimer.on('idle', (idleTimerObject)=>{
    //do some thing when page is idel
});


idleTimer.on('visible', (idleTimerObject)=>{
    //do some thing when page is visbile 
});


idleTimer.on('hidden', (idleTimerObject)=>{
    //do some thing when page is hidden
});

idleTimer.on('warn', (idleTimerObject)=>{
    //do some thing when  event is warn
});

idleTimer.reset(); // reset timer

idleTimer.stop(); // stop timer
 
idleTimer.isExpired() // check if idle timer is expried useful when page is relaod  
 
 

Run Test

npm run test [test is pending]

License

MIT, see LICENSE.md for more information.

multitab_idle_timer's People

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.