useScroll
优雅监听元素的滚动位置的 Hook。
代码演示
基础用法
监测整页的滚动
控制滚动状态的监听
API
const position = useScroll(target, shouldUpdate)
const position = useScroll(target, shouldUpdate)
Params
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
target | DOM 节点或者 ref | Element | Document | (() => Element) | JSX.Element | document |
shouldUpdate | 控制是否更新滚动信息 | ({ top: number, left: number }) => boolean | - |
Result
参数 | 说明 | 类型 |
---|---|---|
position | 滚动容器当前的滚动位置 | Readonly<Ref<{ left: number, top: number } | undefined>> |