Scrollbar 滚动条

用于替换浏览器原生滚动条。

基础用法

通过 height 属性设置滚动条高度,若不设置则根据父容器高度自适应。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

横向滚动

当元素宽度大于滚动条宽度时,会显示横向滚动条。

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

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

最大高度

当元素高度超过最大高度,才会显示滚动条。

1

2

3

手动滚动

通过使用 setScrollTop 与 setScrollLeft 方法,可以手动控制滚动条滚动。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

无限滚动2.10.0

end-reached 是在滚动条到达底部时触发的。它可以用作无限滚动。

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

29

30

Scrollbar API

Scrollbar Attributes

属性名说明类型默认值
height滚动条高度string / number—
max-height滚动条最大高度string / number—
native是否使用原生滚动条样式booleanfalse
wrap-stylewrap 容器的样式object—
wrap-classwrap 容器的类名string—
view-styleview 的样式object—
view-classview 的类名string—
noresize容器尺寸不变时置为 true 可省去尺寸监听booleanfalse
tagview 的标签名stringdiv
always是否总是显示滚动条booleanfalse
min-size滚动条最小尺寸number20
idview 的 idstring—
roleview 的 rolestring—
aria-labelview 的 aria-labelstring—
aria-orientationview 的 aria-orientationenum—
tabindexwrap 的 tabindexnumber / string—
distance触发 end-reached 的距离阈值(px)number0

Scrollbar Events

事件名说明参数
onScroll滚动时触发,返回滚动距离Function
onEndReached滚动到边界时触发Function

Scrollbar Slots

插槽名说明React 写法
default自定义默认内容children

Scrollbar Exposes

方法名说明类型
wrapRefscrollbar wrap 的 refobject
update手动更新滚动条状态Function
scrollTo滚动到指定坐标Function
setScrollTop设置距顶部距离Function
setScrollLeft设置距左侧距离Function
handleScroll处理滚动事件Function