Scrollbar 滚动条
用于替换浏览器原生滚动条。
基础用法
通过 height
属性设置滚动条高度,若不设置则根据父容器高度自适应。
横向滚动
当元素宽度大于滚动条宽度时,会显示横向滚动条。
最大高度
当元素高度超过最大高度,才会显示滚动条。
手动滚动
使用 setScrollTop
与 setScrollLeft
方法可以手动控制滚动条滚动。
无限滚动 2.10.0
当滚动条到达底部时,会触发 end-reached
事件。它可以用来实现无限滚动。
API
属性
名称 | 描述 | 类型 | 默认值 |
---|---|---|---|
高度 | 滚动条高度 | string / number | — |
max-height | 滚动条最大高度 | string / number | — |
原生 | 是否使用原生滚动条样式 | boolean | false |
wrap-style | 包裹容器的自定义样式 | string / object | — |
wrap-class | 包裹容器的自定义类名 | string | — |
view-style | 视图的自定义样式 | string / object | — |
view-class | 视图的自定义类名 | string | — |
noresize | 不响应容器尺寸变化,如果容器尺寸不会发生变化,最好设置它可以优化性能 | boolean | false |
tag | 视图的元素标签 | string | div |
总是 | 总是显示滚动条 | boolean | false |
min-size | 滚动条的最小尺寸 | number | 20 |
id 2.4.0 | 视图的 id | string | — |
role 2.4.0 a11y | 视图的角色 | string | — |
aria-label 2.4.0 a11y | 视图的 aria-label | string | — |
aria-orientation 2.4.0 a11y | 视图的 aria-orientation | 枚举 | — |
tabindex 2.8.3 | 包裹容器的 tabindex | number / string | — |
distance 2.10.5 | 触发 end-reached 事件的距离(像素) | number | 0 |
事件
名称 | 描述 | 类型 |
---|---|---|
scroll | 滚动时触发,返回滚动的距离 | Function |
end-reached 2.10.0 | 滚动到底部时触发 | Function |
插槽
名称 | 描述 |
---|---|
default | 自定义默认内容 |
暴露
名称 | 描述 | 类型 |
---|---|---|
handleScroll | 处理滚动事件 | Function |
scrollTo | 滚动到一组特定坐标 | Function |
setScrollTop | 设置滚动条到顶部的距离 | Function |
setScrollLeft | 设置滚动条到左边的距离 | Function |
update | 手动更新滚动条状态 | Function |
wrapRef | 滚动条包裹元素的 ref | object |