vue2.x自定义虚拟滚动条|vue美化滚动条组件Vscroll

简介#

VScroll 基于 vuejs2.x 构建的 PC 桌面端自定义模拟滚动条组件。支持是否原生滚动条、鼠标滑出是否隐藏滚动条、自定义滚动条尺寸、层级及颜色等功能。拥有丝滑般滚动效果!

只需 <v-scroll>...</v-scroll> 即可快速模拟出一个漂亮的虚拟滚动条。

引入组件#

在 main.js 中引入滚动条组件。

import VScroll from './components/vscroll'
Vue.use(VScroll)

参数配置#

props: {
    // 是否显示原生滚动条
    native: Boolean,
    // 是否自动隐藏滚动条
    autohide: Boolean,
    // 滚动条尺寸
    size: { type: [Number, String], default: '' },
    // 滚动条颜色
    color: String,
    // 滚动条层级
    zIndex: null
},

使用组件#

<!-- 原生滚动条 -->
<v-scroll native>
    <img src="https://cn.vuejs.org/images/logo.png" />
    <p>这里是自定义内容。这里是自定义内容。这里是自定义内容。</p>
</v-scroll>

<!-- 参数配置 -->
<v-scroll autohide size="15" color="#00a1e0" zIndex="2021">
    <img src="https://cn.vuejs.org/images/logo.png" />
    <p>这里是自定义内容。这里是自定义内容。这里是自定义内容。</p>
</v-scroll>

实现过程#

vue2.x自定义虚拟滚动条|vue美化滚动条组件Vscroll

<!--vscroll组件模板-->
<template>
  <div class="vui__scrollbar" ref="ref__box" @mouseenter="handleMouseEnter" @mouseleave="handleMouseLeave" v-resize="handleResize">
    <div :class="['vscroll__wrap', {native: native}]" ref="ref__wrap" @scroll="handleScroll">
      <div class="vscroll__view" v-resize="handleResize"><slot /></div>
    </div>
    <!-- //滚动条槽 -->
    <div :class="['vscroll__bar vertical', {ishide: !isShow}]" @mousedown="handleClickTrack($event, 0)" :style="{'width': parseInt(size)>=0 ? parseInt(size)+'px' : '', 'z-index': parseInt(zIndex)>=0 ? parseInt(zIndex) : ''}">
      <div class="vscroll__thumb" ref="ref__barY" :style="{'background': color, 'height': barHeight+'px'}" @mousedown="handleDragThumb($event, 0)"></div>
    </div>
    <div :class="['vscroll__bar horizontal', {ishide: !isShow}]" @mousedown="handleClickTrack($event, 1)" :style="{'height': parseInt(size)>=0 ? parseInt(size)+'px' : '', 'z-index': parseInt(zIndex)>=0 ? parseInt(zIndex) : ''}">
      <div class="vscroll__thumb" ref="ref__barX" :style="{'background': color, 'width': barWidth+'px'}" @mousedown="handleDragThumb($event, 1)"></div>
    </div>
  </div>
</template>

/**
 * @Desc     Vue美化系统滚动条VScroll
 * @Time     andy by 2020/11/30
 * @About    Q:282310962  wx:xy190310
 */
<script>
  import domUtils from './utils/dom'
  export default {
    props: {
      // 显示原生滚动条
      native: Boolean,
      // 自动隐藏滚动条
      autohide: Boolean,
      // 滚动条尺寸
      size: { type: [Number, String], default: '' },
      // 滚动条颜色
      color: String,
      // 滚动条层级
      zIndex: null
    },
    data() {
      return {
        barWidth: 0,            // 滚动条宽度
        barHeight: 0,           // 滚动条高度
        ratioX: 1,              // 滚动条水平偏移率
        ratioY: 1,              // 滚动条垂直偏移率
        isTaped: false,         // 鼠标光标是否按住滚动条
        isHover: false,         // 鼠标光标是否悬停在滚动区
        isShow: !this.autohide, // 是否显示滚动条
      }
    },
    mounted() {
      this.$ref__box = this.$refs.ref__box
      this.$ref__wrap = this.$refs.ref__wrap
      this.$ref__barY = this.$refs.ref__barY
      this.$ref__barX = this.$refs.ref__barX
      this.$nextTick(this.updated)
    },
    // ...
    methods: {
      // 鼠标移入
      handleMouseEnter() {
        this.isHover = true
        this.isShow = true
        this.updated()
      },

      // 鼠标移出
      handleMouseLeave() {
        this.isHover = false
        this.isShow = false
      },

      // 拖动滚动条
      handleDragThumb(e, index) {
        let _this = this
        this.isTaped = true
        let c = {}

        domUtils.isIE() ? (e.returnValue = false, e.cancelBubble = true) : (e.stopPropagation(), e.preventDefault())
        document.onselectstart = () => false

        if(index == 0) {
          c.dragY = true
          c.clientY = e.clientY
        }else {
          c.dragX = true
          c.clientX = e.clientX
        }

        domUtils.on(document, 'mousemove', function(evt) {
          if(_this.isTaped) {
            if(c.dragY) {
              _this.$ref__wrap.scrollTop += (evt.clientY - c.clientY) * _this.ratioY
              _this.$ref__barY.style.transform = `translateY(${_this.$ref__wrap.scrollTop / _this.ratioY}px)`
              c.clientY = evt.clientY
            }
            if(c.dragX) {
              _this.$ref__wrap.scrollLeft += (evt.clientX - c.clientX) * _this.ratioX
              _this.$ref__barX.style.transform = `translateX(${_this.$ref__wrap.scrollLeft / _this.ratioX}px)`
              c.clientX = evt.clientX
            }
          }
        })
        domUtils.on(document, 'mouseup', function() {
          _this.isTaped = false

          document.onmouseup = null;
          document.onselectstart = null
        })
      },

      // 滚动槽
      handleClickTrack(e, index) {
        console.log(index)
      },

      // 更新滚动
      updated() {
        if(this.native) return

        // 垂直滚动条
        if(this.$ref__wrap.scrollHeight > this.$ref__wrap.offsetHeight) {
          this.barHeight = this.$ref__box.offsetHeight **2 / this.$ref__wrap.scrollHeight
          this.ratioY = (this.$ref__wrap.scrollHeight - this.$ref__box.offsetHeight) / (this.$ref__box.offsetHeight - this.barHeight)
          this.$ref__barY.style.transform = `translateY(${this.$ref__wrap.scrollTop / this.ratioY}px)`
        }else {
          this.barHeight = 0
          this.$ref__barY.style.transform = ''
          this.$ref__wrap.style.marginRight = ''
        }

        // 水平滚动条
        ...
      },

      handleResize() {
        // 更新滚动条状态
      },

      // ...
    }
  }
</script>

通过 vue 的指令函数 directives 来实时监听 DOM 尺寸变化。

// 监听元素/DOM尺寸变化
directives: {
    'resize': {
        bind: function(el, binding) {
            let width = '', height = '';
            function get() {
            const elStyle = el.currentStyle ? el.currentStyle : document.defaultView.getComputedStyle(el, null);
            if (width !== elStyle.width || height !== elStyle.height) {
                binding.value({width, height});
            }
            width = elStyle.width;
            height = elStyle.height;
            }
            el.__vueReize__ = setInterval(get, 16);
        },
        unbind: function(el) {
            clearInterval(el.__vueReize__);
        }
    }
},

<v-scroll @scroll="handleEvtScroll">
    <img src="img/logo.png" style="height:600px;" />
    <p>这里是内容信息!这里是内容信息!这里是内容信息!</p>
</v-scroll>

// 监听滚动事件
handleEvtScroll(e) {
    this.scrollTop = e.target.scrollTop
    // 判断滚动状态
    if(e.target.scrollTop == 0) {
        this.scrollStatus = '到达顶部'
    } else if(e.target.scrollTop + e.target.offsetHeight >= e.target.scrollHeight) {
        this.scrollStatus = '到达底部'
    }else {
        this.scrollStatus = '滚动中....'
    }
}

ok,以上就是 vue.js 实现 XY 轴自定义滚动条组件,如果大家有兴趣可以自己去尝试下哈。💪

vue.js 桌面 PC 端对话框组件 VLayer
基于 vue.js 自定义移动端对话框组件 VPopup

本作品采用《CC 协议》,转载必须注明作者和本文链接
本文为原创文章,未经作者允许不得转载,欢迎大家一起交流 QQ(282310962) wx(xy190310)
讨论数量: 3
cnguu

相比 element 框架的滚动条组件,有什么特色呢?

4年前 评论

@cnguu 可以自定义滚动条尺寸、颜色及 zIndex 层级。

4年前 评论

大佬有项目地址吗,想学习一下

2年前 评论

文章
65
粉丝
52
喜欢
108
收藏
57
排名:356
访问:2.7 万
私信
所有博文
博客标签
展开
社区赞助商