Skip to content
On this page

useScroll

优雅监听元素的滚动位置的 Hook。

代码演示

基础用法

监测整页的滚动

控制滚动状态的监听

API

const position = useScroll(target, shouldUpdate)
const position = useScroll(target, shouldUpdate)

Params

参数说明类型默认值
targetDOM 节点或者 refElement | Document | (() => Element) | JSX.Elementdocument
shouldUpdate控制是否更新滚动信息({ top: number, left: number }) => boolean-

Result

参数说明类型
position滚动容器当前的滚动位置Readonly<Ref<{ left: number, top: number } | undefined>>

Source

源码文档示例