File size: 430 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
# `useScroll`
React sensor hook that re-renders when the scroll position in a DOM element changes.
## Usage
```jsx
import {useScroll} from 'react-use';
const Demo = () => {
const scrollRef = React.useRef(null);
const {x, y} = useScroll(scrollRef);
return (
<div ref={scrollRef}>
<div>x: {x}</div>
<div>y: {y}</div>
</div>
);
};
```
## Reference
```ts
useScroll(ref: RefObject<HTMLElement>);
```
|