mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-14 17:31:02 +08:00
c6bed151a5
* feat(website): init viteperss (#3162) * init vitepress * Finish homepage * relayout page * partial finish * update * update use lang * remove font weight; change font size * docs: optimize docs folder structure * reorganize project * fix ssr issue * fix build issues Co-authored-by: Kevin <sxzz@sxzz.moe> Co-authored-by: zouhang <zouhang@didiglobal.com> * feat(website) integrate with crowdin (#3218) - Introduce Crowdin CLI - Add script for fetching Crowdin token from env - Add script for local development * fix formatting * update codeblocks (#3249) * feat(docs): update website preview script - Update azure preview build script - Eliminate dead links * bootstrap docs * fix homepage layout issue * fix formating * Finish ToC and codepen integration * reorganized files and fix issue that causes demo unavailable after build * feat(docs): migration documentations (#3283) * feat(docs): migration documentations - Move documentations to docs/ * remove unused files * docs: [popconfirm] migrate document (#3285) * feat(docs): migrate documentation from space.md to upload.md (#3292) - Upload documentations acorrodingly * docs: [date-picker] migrate document (#3289) * docs: [date-picker] migrate document * fix: typo * docs: [slider] migrate document (#3287) * docs: migrate documents (#3290) * docs: migrate-datetime-picker * docs: migrate descriptions * docs: migrate dialog * docs: migrate divider * docs: migrate drawer * docs: migrate drapdown * docs: fix drapdown * docs: migrate empty * docs: migrate form * docs: add scoped for style * docs: simplify toRefs * chore: update doc (#3297) * chore: update doc * chore: update doc * chore: update doc * feat(docs): migrate documentations from infinite-scroll to page-header (#3303) - Update docs accordingly - Update CodePen icon to match style - Update component name to match others * docs: migrate documentions (#3293) migrate list: * image * popover * scrollbar * radio * rate * skeleton * select * select-v2 * reault * progress * pagination * chore: update doc (#3305) Co-authored-by: 0song <0song@gmail.com> * Fix broken pipeline * chore: update demo plugin * website perfection * fix hydration bug * docs: update guide (#3342) * WIP docs * docs: update docs * add dark mode * make dev fetch components from local instead of node_modules Co-authored-by: msidolphin <msidolphin@outlook.com> Co-authored-by: Aex <spryti@qq.com> Co-authored-by: 0song <82012629+0song@users.noreply.github.com> Co-authored-by: 0song <0song@gmail.com> Co-authored-by: zouhang <zouhang@didiglobal.com> Co-authored-by: 三咲智子 <sxzz@sxzz.moe> * fix(docs): fix codepen code example issue (#3380) * fix(docs): fix codepen code example issue - Add lang="ts" for all example files - Fix codepen import error * revert changes in resource.vue * feat(docs): complete crowdin integration (#3408) * Update mds for preparing the integration script * deprecate old website * update sponsors and even handler for resize * update build script for preview * fix preview-build error * fix preview-build error * fix preview-build error * fix preview-build error * fix preview-build error * update deploy script and some bugs * Fix existing issue * chore(project): add dev preview workflow * chore(project): rename dev to staging * update the size of toc * update staging-preview script * update preview scripts * enable website build for preview * fix build error * final commitment for update the details * remove azure pipeline * move docs ignores into docs and update date Co-authored-by: Kevin <sxzz@sxzz.moe> Co-authored-by: zouhang <zouhang@didiglobal.com> Co-authored-by: msidolphin <msidolphin@outlook.com> Co-authored-by: Aex <spryti@qq.com> Co-authored-by: 0song <82012629+0song@users.noreply.github.com> Co-authored-by: 0song <0song@gmail.com>
108 lines
4.7 KiB
Markdown
108 lines
4.7 KiB
Markdown
# Scrollbar
|
|
|
|
Used to replace the browser's native scrollbar.
|
|
|
|
<style lang="scss">
|
|
.example-showcase {
|
|
.el-scrollbar {
|
|
.scrollbar-demo-item {
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: center;
|
|
height: 50px;
|
|
margin: 10px;
|
|
text-align: center;
|
|
border-radius: 4px;
|
|
background: var(--el-color-primary-light-9);
|
|
color: var(--el-color-primary);
|
|
}
|
|
|
|
.flex-content {
|
|
display: flex;
|
|
|
|
.scrollbar-demo-item {
|
|
flex-shrink: 0;
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: center;
|
|
width: 100px;
|
|
height: 50px;
|
|
margin: 10px;
|
|
text-align: center;
|
|
border-radius: 4px;
|
|
background: var(--el-color-danger-lighter);
|
|
color: var(--el-color-danger);
|
|
}
|
|
}
|
|
}
|
|
.el-button {
|
|
margin-bottom: 20px;
|
|
}
|
|
.el-slider {
|
|
margin-top: 20px;
|
|
}
|
|
}
|
|
</style>
|
|
|
|
## 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
|
|
|
|
| Attribute | 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
|
|
|
|
| Event Name | Description | Parameters |
|
|
| ---------- | ----------------------- | ----------------------------------------------- |
|
|
| scroll | triggers when scrolling | distance of scrolling { scrollLeft, scrollTop } |
|
|
|
|
## Scrollbar Methods
|
|
|
|
| Method | Description | Parameters |
|
|
| ------------- | ------------------------------- | -------------------- |
|
|
| setScrollTop | Set distance to scroll top | (scrollTop: number) |
|
|
| setScrollLeft | Set distance to scroll left | (scrollLeft: number) |
|
|
| update | update scrollbar state manually | — |
|