mirror of
https://github.com/streamich/react-use.git
synced 2025-12-08 18:02:14 +00:00
27 lines
453 B
Markdown
27 lines
453 B
Markdown
# `useScrolling`
|
|
|
|
React sensor hook that keeps track of whether the user is scrolling or not.
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
import { useScrolling } from "react-use";
|
|
|
|
const Demo = () => {
|
|
const scrollRef = React.useRef(null);
|
|
const scrolling = useScrolling(scrollRef);
|
|
|
|
return (
|
|
<div ref={scrollRef}>
|
|
{<div>{scrolling ? "Scrolling" : "Not scrolling"}</div>}
|
|
</div>
|
|
);
|
|
};
|
|
```
|
|
|
|
## Reference
|
|
|
|
```ts
|
|
useScrolling(ref: RefObject<HTMLElement>);
|
|
```
|