mirror of
https://github.com/streamich/react-use.git
synced 2025-12-08 18:02:14 +00:00
42 lines
955 B
Markdown
42 lines
955 B
Markdown
# `useInterval`
|
|
|
|
A declarative interval hook based on [Dan Abramov's article on overreacted.io](https://overreacted.io/making-setinterval-declarative-with-react-hooks). The interval can be paused by setting the delay to `null`.
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
import * as React from 'react';
|
|
import {useInterval} from 'react-use';
|
|
|
|
const Demo = () => {
|
|
const [count, setCount] = React.useState(0);
|
|
const [delay, setDelay] = React.useState(1000);
|
|
const [isRunning, toggleIsRunning] = useBoolean(true);
|
|
|
|
useInterval(
|
|
() => {
|
|
setCount(count + 1);
|
|
},
|
|
isRunning ? delay : null
|
|
);
|
|
|
|
return (
|
|
<div>
|
|
<div>
|
|
delay: <input value={delay} onChange={event => setDelay(Number(event.target.value))} />
|
|
</div>
|
|
<h1>count: {count}</h1>
|
|
<div>
|
|
<button onClick={toggleIsRunning}>{isRunning ? 'stop' : 'start'}</button>
|
|
</div>
|
|
</div>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Reference
|
|
|
|
```js
|
|
useInterval(callback, delay?: number)
|
|
```
|