react-use/docs/useThrottle.md
streamich 0ccdf9531e feat: 🎸 add useThrottleFn hook that throttles function
This hook used to be called useThrottle, but it also was re-implemented.
2019-03-27 22:22:27 +01:00

30 lines
535 B
Markdown

# `useThrottle` and `useThrottleFn`
React hooks that throttle.
## Usage
```jsx
import React, { useState } from 'react';
import { useThrottle, useThrottleFn } from 'react-use';
const Demo = ({value}) => {
const throttledValue = useThrottle(value);
// const throttledValue = useThrottleFn(value => value, 200, [value]);
return (
<>
<div>Value: {value}</div>
<div>Throttled value: {throttledValue}</div>
</>
);
};
```
## Reference
```ts
useThrottle(value, ms?: number);
useThrottleFn(fn, ms, args);
```