Browse files

Add some docs for the new features

  • Loading branch information...
1 parent 3cf5a71 commit fa93a6ed6948e2921b16566c47da1bc5e5abe7dc Al committed Feb 8, 2012
Showing with 8 additions and 0 deletions.
  1. +8 −0 jquery.idle-timer.js
8 jquery.idle-timer.js
@@ -75,6 +75,14 @@
// you may just want page-level activity, in which case you may set up
// your timers on document, document.documentElement, and document.body
+ // You can optionally provide a second argument to override certain options.
+ // Here are the defaults, so you can omit any or all of them.
+ $(elem).idleTimer(timeout, {
+ startImmediately: true, //starts a timeout as soon as the timer is set up; otherwise it waits for the first event.
+ idle: false, //indicates if the user is idle
+ enabled: true, //indicates if the idle timer is enabled
+ events: 'mousemove keydown DOMMouseScroll mousewheel mousedown touchstart touchmove' // activity is one of these events
+ });

0 comments on commit fa93a6e

Please sign in to comment.