Files
element-plus/website/docs/es/scrollbar.md
kooriookami 7a1457bce0 feat(scrollbar): add docs and params (#1859)
* feat(scrollbar): add docs and params

* fix: fix wrapStyle

* feat: add test

* feat: update
2021-04-20 10:44:10 +08:00

2.4 KiB

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.

<el-scrollbar height="400px">
  <p class="item" v-for="item in 20">{{ item }}</p>
</el-scrollbar>

:::

Horizontal scroll

:::demo When the element width is greater than the scrollbar width, the horizontal scrollbar is displayed.

<el-scrollbar>
  <div class="flex-content">
    <p class="item" v-for="item in 50">{{ item }}</p>
  </div>
</el-scrollbar>

:::

Max height

:::demo The scrollbar is displayed only when the element height exceeds the max height.

<template>
  <el-button @click="add">Add Item</el-button>
  <el-button @click="delete">Delete Item</el-button>
  <el-scrollbar max-height="400px">
    <p class="item" v-for="item in count">{{ item }}</p>
  </el-scrollbar>
</template>

<script>
  export default {
    data() {
      return {
        count: 3
      }
    },
    methods: {
      add() {
        this.count++
      },
      delete() {
        if (this.count > 0) {
          this.count--
        }
      }
    }
  }
</script>

:::

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

Events

Event Name Description Parameters
scroll triggers when scrolling distance of scrolling { scrollLeft, scrollTop }