use-idle

v4.7.0

STATUS

Passing

DOWNLOADS

VISIBILITY

Public

PUBLISHED

6 years ago

SIZE

N/A

React

1 contributor

Install use-idle as a package?

Copied

npm i @bit/giladshoham.react-hooks.use.use-idle

Set Bit as a scoped registryLearn more

npm config set '@bit:registry' https://node.bit.cloud

Component Example

React

Vue

Angular

React Native

Add dependency...

Just

import

any of the 1 million components

and packages in Bit or NPM to the example.

import Button from '@bit/grommet.grommet.button';
import Lodash from 'lodash';

`useIdle`

React sensor hook that tracks if user on the page is idle.

Usage

import {useIdle} from 'react-use';

const Demo = () => {
  const isIdle = useIdle(3e3);

  return (
    <div>
      <div>Use is idle: {isIdle ? 'Yes' : 'No'}</div>
    </div>
  );
};

Reference

useIdle(ms, initialState);

ms — time in milliseconds after which to consider use idle, defaults to 60e3 — one minute.
initialState — whether to consider user initially idle, defaults to false.