1.0.1 • Published 4 years ago

react-idle-detector v1.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

react-idle-detector

npm version

Small sized react component for detect idle (no activity) time on your components. This component calls callback function each time, when user has no activity on your component/components collection. It can be useful to show some notifications, or call some other methods to draw user's attention

Demo

Edit jovial-meitner-9xbou

Installing

using npm

npm i react-idle-detector

using yarn

yarn add react-idle-detector

Usage

import IdleDetector from 'react-idle-detector';

const noActivityHandler = () => {
  console.log('no activity');
};

<IdleDetector
  events={['mousemove']} // Array of listen events
  onNoActivity={noActivityHandler} // callback on no activity
  idleTime={60000} // no activity time, ms
>
  {/* watching component/components */}
  <Layout />
</IdleDetector>;

API

NameTypeDefaultDescription
eventsarray'mousemove'Array of user's events
onNoActivityfunction()=> undefinedCallback, calls on no activity
idleTimenumber60000Idle time in milliseconds