Scrollbar
Used to replace the browser's native scrollbar.
Basic usage
Use height
property to set the height of the scrollbar, or if not set, it adapts according to the parent container height.
Horizontal scroll
When the element width is greater than the scrollbar width, the horizontal scrollbar is displayed.
Max height
The scrollbar is displayed only when the element height exceeds the max height.
Manual scroll
Use setScrollTop
and setScrollLeft
methods can control scrollbar manually.
API
Attributes
Name | Description | Type | Default |
---|---|---|---|
height | height of scrollbar | string / number | — |
max-height | max height of scrollbar | string / number | — |
native | whether to use the native scrollbar style | boolean | false |
wrap-style | style of wrap container | string / object | — |
wrap-class | class of wrap container | string | — |
view-style | style of view | string / object | — |
view-class | class of view | string | — |
noresize | do not respond to container size changes, if the container size does not change, it is better to set it to optimize performance | boolean | false |
tag | element tag of the view | string | div |
always | always show scrollbar | boolean | false |
min-size | minimum size of scrollbar | number | 20 |
id 2.4.0 | id of view | string | — |
role 2.4.0 a11y | role of view | string | — |
aria-label 2.4.0 a11y | aria-label of view | string | — |
aria-orientation 2.4.0 a11y | aria-orientation of view | enum | — |
tabindex 2.8.3 | tabindex of wrap container | number / string | — |
Events
Name | Description | Type |
---|---|---|
scroll | triggers when scrolling, return distance of scrolling | Function |
Slots
Name | Description |
---|---|
default | customize default content |
Exposes
Name | Description | Type |
---|---|---|
handleScroll | handle scroll event | Function |
scrollTo | scrolls to a particular set of coordinates | Function |
setScrollTop | Set distance to scroll top | Function |
setScrollLeft | Set distance to scroll left | Function |
update | update scrollbar state manually | Function |
wrapRef | scrollbar wrap ref | object |