Giter Club home page Giter Club logo

idle-tabs's Introduction

idle-tabs

A utility module for tracking user activity on different tabs of same website, with keepalive event, can be used for maintaining sessions where there is token based authentication to preserve or notify users.

For simple user event tracking use idle-js instead.

Usage

npm i idle-tabs

import  idleTabs from 'idle-tabs';
//or
// import { idleTabs } from 'idle-tabs' 

//optiins example with default values
const configs = {
  idleTime: 2,
  debug: false,
  events: ['mousemove', 'keydown', 'mousedown', 'touchstart'], // events that will trigger the idle resetter
  onIdle: () => { }, // callback function to be executed after idle time
  onActive: () => { }, // callback function to be executed after back form idleness
  onAlive: () => { }, // callback function to be executed after back form idleness
  onHide: () => { }, // callback function to be executed when this.$window become hidden
  onShow: () => { }, // callback function to be executed when this.$window become visible
  keepTracking: true, // set it to false of you want to track only once
  keepAlive: true,
  startAtIdle: false, // set it to true if you want to start in the idle state
  recurIdleCall: false,
  storePrefix: 'mysite', // string sufix to localstorage key
};

const idle = idleTabs(configs, window, document);

idle.start()

// later on somewhere else
  var a = idleTabs(); // returns same instance always
  a.start();


  var a = idleTabs();
  a.reset();


  var a = idleTabs();
  a.stop();

IdleClass

IdleClass is exported and can be used to initialize or extend it.

import { IdleClass } from 'idle-tabs'

var idle = new IdleClass({})

idle-tabs's People

Contributors

satyamyadav avatar

Watchers

James Cloos 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.