- props
- timeout
- events
- onIdle
- onActive
- onAction
- debounce
- throttle
- element
- startOnMount
- stopOnIdle
- passive
- capture
- methods
- reset
- pause
- resume
- getRemainingTime
- getElapsedTime
- getLastActiveTime
- isIdle
- utilities
- debounced
- throttled
Activity Timeout in milliseconds default: 1200000
Type: Number
DOM events to listen to default: see default events
Type: Array
Function to call when user is idle default: () => {}
Type: Function
Function to call when user becomes active default: () => {}
Type: Function
Function to call on user actions default: () => {}
Type: Function
Debounce the onAction function by setting delay in milliseconds default: 0
Type: Number
Throttle the onAction function by setting delay in milliseconds default: 0
Type: Number
Element reference to bind activity listeners to default: document
Type: Object
Start the timer on mount default: true
Type: Boolean
Once the user goes idle the IdleTimer will not reset on user input instead, reset() must be called manually to restart the timer default: false
Type: Boolean
Bind events passively default: true
Type: Boolean
Capture events default: true
Type: Boolean
Restore initial state and restart timer
Store remaining time and stop timer
Resumes a paused timer
Time remaining before idle
Returns Number Milliseconds remaining
How much time has elapsed
Returns Timestamp
Last time the user was active
Returns Timestamp
Returns wether or not the user is idle
Returns Boolean
Creates a debounced function that delays invoking func until after delay milliseconds has elapsed since the last time the debounced function was invoked.
Returns Function Executed Function *
Creates a throttled function that only invokes func at most once per every wait milliseconds.
Returns Function Executed Function *