mirror of
https://github.com/streamich/react-use.git
synced 2026-01-18 14:06:52 +00:00
32 lines
588 B
Markdown
32 lines
588 B
Markdown
# `useRaf`
|
|
|
|
React animation hook that forces component to re-render on each `reaquestAnimationFrame`,
|
|
returns percentage of time elapsed.
|
|
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
import {useRaf} from 'react-use';
|
|
|
|
const Demo = () => {
|
|
const elapsed = useRaf(5000, 1000);
|
|
|
|
return (
|
|
<div>
|
|
Elapsed: {elapsed}
|
|
</div>
|
|
);
|
|
};
|
|
```
|
|
|
|
|
|
## Reference
|
|
|
|
```ts
|
|
useRaf(ms?: number, delay?: number): number;
|
|
```
|
|
|
|
- `ms` — milliseconds for how long to keep re-rendering component, defaults to `1e12`.
|
|
- `delay` — delay in milliseconds after which to start re-rendering component, defaults to `0`.
|