mirror of
https://github.com/streamich/react-use.git
synced 2026-01-18 14:06:52 +00:00
31 lines
526 B
Markdown
31 lines
526 B
Markdown
# `useIdle`
|
|
|
|
React sensor hook that tracks if user on the page is idle.
|
|
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
import {useIdle} from 'react-use';
|
|
|
|
const Demo = () => {
|
|
const isIdle = useIdle(3e3);
|
|
|
|
return (
|
|
<div>
|
|
<div>Use is idle: {isIdle ? 'Yes' : 'No'}</div>
|
|
</div>
|
|
);
|
|
};
|
|
```
|
|
|
|
|
|
## Reference
|
|
|
|
```js
|
|
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.
|