mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-15 18:01:24 +08:00
78 lines
4.3 KiB
Markdown
78 lines
4.3 KiB
Markdown
---
|
|
title: Scrollbar
|
|
lang: en-US
|
|
---
|
|
|
|
# Scrollbar
|
|
|
|
Used to replace the browser's native scrollbar.
|
|
|
|
## Basic usage
|
|
|
|
:::demo Use `height` property to set the height of the scrollbar, or if not set, it adapts according to the parent container height.
|
|
|
|
scrollbar/basic-usage
|
|
|
|
:::
|
|
|
|
## Horizontal scroll
|
|
|
|
:::demo When the element width is greater than the scrollbar width, the horizontal scrollbar is displayed.
|
|
|
|
scrollbar/horizontal-scroll
|
|
|
|
:::
|
|
|
|
## Max height
|
|
|
|
:::demo The scrollbar is displayed only when the element height exceeds the max height.
|
|
|
|
scrollbar/max-height
|
|
|
|
:::
|
|
|
|
## Manual scroll
|
|
|
|
:::demo Use `setScrollTop` and `setScrollLeft` methods can control scrollbar manually.
|
|
|
|
scrollbar/manual-scroll
|
|
|
|
:::
|
|
|
|
## Scrollbar Attributes
|
|
|
|
| Name | Description | Type | Accepted Values | 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 warp container | string | — | — |
|
|
| wrap-class | class of warp container | string | — | — |
|
|
| view-style | style of view | string | — | — |
|
|
| 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 |
|
|
|
|
## Scrollbar Events
|
|
|
|
| Name | Description | Parameters |
|
|
| ------ | ----------------------- | ------------------------------------------------- |
|
|
| scroll | triggers when scrolling | distance of scrolling `{ scrollLeft, scrollTop }` |
|
|
|
|
## Scrollbar Methods
|
|
|
|
| Method | Description | Parameters |
|
|
| ------------- | ------------------------------------------ | ----------------------------------------------------- |
|
|
| scrollTo | scrolls to a particular set of coordinates | (options: ScrollToOptions \| number, yCoord?: number) |
|
|
| setScrollTop | Set distance to scroll top | (scrollTop: number) |
|
|
| setScrollLeft | Set distance to scroll left | (scrollLeft: number) |
|
|
| update | update scrollbar state manually | — |
|
|
|
|
## Scrollbar Slots
|
|
|
|
| Name | Description |
|
|
| ---- | ------------------------- |
|
|
| — | customize default content |
|