Detecting when the user becomes inactive (idle) or active
npm install @react-corekit/use-idle> Detecting when the user becomes inactive (idle) or active.
 
``bash`
npm install --save @react-corekit/use-idle
`bash`
yarn add @react-corekit/use-idle
`jsx
import React from "react";
import { useIdle } from "@react-corekit/use-idle";
const Example = () => {
const options = { timeToIdle: 1000 };
const isIdle = useIdle(options);
return
mousemove event is ignored by default, to include it add the following line to the options object:
javascript
const options = { ignoredEventsWhenIdle: [] };
`$3
Activity detector allows you to configure some parameters:
-
: number of milliseconds of inactivity which makes activity detector transition to 'idle' (30000 by default)
- activityEvents: the user events which make activity detector transition from 'idle' to 'active'. The default list of activityEvents is ['click', 'mousemove', 'keydown', 'DOMMouseScroll', 'mousewheel', 'mousedown', 'touchstart', 'touchmove', 'focus']
- : the list of events which make the activity detector transition from 'active' to 'idle' without waiting for timeToIdle timeout. By default: ['blur']
- : list of events to ignore in idle state. By default: ['mousemove']
- : can be "idle" or "active" ("active"` by default)> Visit: https://react-corekit.github.io/use-idle/ for a minimalistic live demo (Including _mousemove_ event).
MIT © glongh