前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >VScroll:基于Vue美化滚动条组件|vue.js自定义滚动条

VScroll:基于Vue美化滚动条组件|vue.js自定义滚动条

原创
作者头像
andy2018
修改2020-12-01 16:51:03
18.7K1
修改2020-12-01 16:51:03
举报
文章被收录于专栏:h5h5

前言

前段时间有给大家分享一款Vuejs自定义PC端对话框组件VLayer,最近有个项目需要用到自定义滚动条功能,于是又捣鼓了一个Vue桌面端自定义模拟滚动条组件。

VScroll 一款基于vue2.x构建的虚拟替代系统原生滚动条组件。支持自定义是否原生滚动条、自动隐藏、滚动条大小及颜色等功能。拥有完美顺滑的滚动体验!

使用起来非常简单,只需要<v-scroll></v-scroll>包裹住需要滚动的内容,即可快速构建一个丝滑般的滚动条。

如上图:当滚动内容超过容器盒子,就会出现垂直/水平滚动条。

支持参数

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

另外还支持设置滚动条zIndex层级。

引入组件

代码语言:javascript
复制
// 在main.js中引入vscroll组件
import VScroll from './components/vscroll'
Vue.use(VScroll)

使用组件

代码语言:javascript
复制
<!-- 原生滚动条 -->
<v-scroll native>
    <img src="images/logo.png" />
    <p>这里是自定义内容。这里是自定义内容。这里是自定义内容。</p>
</v-scroll>
 
<!-- 自定义参数配置 -->
<v-scroll autohide size="15" color="#00a1e0" zIndex="8080">
    <img src="images/logo.png" />
    <p>这里是自定义内容。这里是自定义内容。这里是自定义内容。</p>
</v-scroll>

如下图:当滚动区尺寸或内容改变,会自动更新滚动条。

编码开发

在components目录下新建vscroll目录,并新建组件模板。

代码语言:javascript
复制
<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     VueJs虚拟滚动条组件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.js中如何监测当滚动区尺寸或内容更新时,滚动条也更新呢?非常简单,只需通过下面directives指令来轮询即可。

代码语言:javascript
复制
// 监听元素/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__);
        }
    }
},

另外还支持调用scrollTo方法设置滚动到指定位置,@scroll事件来监听滚动事件。

代码语言:javascript
复制
<v-scroll @scroll="checkScroll">
    <img src="images/logo.png" style="height:300px;" />
    <br />
    <p><img src="images/logo.png" style="height:550px;" /></p>
    <p>这里是内容信息!这里是内容信息!这里是内容信息!</p>
</v-scroll>
 
// 监听滚动事件
checkScroll(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开发自定义滚动条的介绍,希望对大家有所帮助哈!💪💪

最后,分享一个Vue PC端自定义弹窗组件。

vue.js自定义网页对话框组件VLayer

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • 支持参数
  • 引入组件
  • 使用组件
  • 编码开发
相关产品与服务
容器服务
腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档