Skip to content

Scrollbar 滚动条

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

基本用法

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

横向滚动

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

最大高度

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

手动控制

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

API

Attributes

参数说明类型默认值
height滚动条高度string / number
max-height滚动条最大高度string / number
native是否使用原生滚动条样式booleanfalse
wrap-style包裹容器的自定义样式string / CSSProperties | CSSProperties[] | string[]
wrap-class包裹容器的自定义类名string
view-style视图的自定义样式string / CSSProperties | CSSProperties[] | string[]
view-class视图的自定义类名string
noresize不响应容器尺寸变化,如果容器尺寸不会发生变化,最好设置它可以优化性能booleanfalse
tag视图的元素标签stringdiv
always滚动条总是显示booleanfalse
min-size滚动条最小尺寸number20
id视图 IDstring
role视图的角色string
aria-label视图的 aria-labelstring
aria-orientation视图的 aria-orientation'horizontal' | 'vertical'

Slots

名称说明
default默认内容

Events

事件名称说明类型
scroll滑动时触发,返回滚动的距离({ scrollLeft: number, scrollTop: number }) => void

Exposes

名称说明类型
handleScroll触发滚动事件() => void
scrollTo滚动到一组特定坐标(options: ScrollToOptions | number, yCoord?: number) => void
setScrollTop设置滚动条到顶部的距离(scrollTop: number) => void
setScrollLeft设置滚动条到左边的距离(scrollLeft: number) => void
update手动更新滚动条状态() => void
wrapRef滚动条包裹的 ref 对象Ref<HTMLDivElement>