基于vue3的滚动条组件

最近开始尝试vue3开发项目,用了ant-design-vue框架,但是发现没有滚动条组件,因此自己尝试着写了一个,有需要的可以使用,有什么问题可以给我提issue。

地址:https://github.com/chenjiaj/c-scrollbar
查看效果:https://chenjiaj.github.io/c-scrollbar/

基于vue3的滚动条组件

一、使用
npm install c-scrollbar --save // 下载依赖

全局注册 main.ts

import { createApp } from 'vue';
import CScrollbar from 'c-scrollbar';
import App from './App.vue';

createApp(App).use(cScrollbar).mount('#app');

局部引入

import {CScrollbar} from 'c-scrollbar';
export default{
  components: {
    CScrollbar,
  },
}

App.vue


二、属性
属性 类型 默认值 说明
maxHeight String '' 垂直方向 ,内容超过此高度出现滚动条。maxHeight、height必须设置一个,否者不生效
maxWidth String '' 水平方向 ,内容超过此高度出现滚动条 。
height String '' 垂直方向,内容超过此高度出现滚动条。最好不要使用百分比,除非父级元素设置了具体高度。maxHeight、height必须设置一个,否者不生效
width String '' 水平方向 ,内容超过此高度出现滚动条 。
trigger String 'always' 触发显示滚动条。可填写的值有 'always'、'hover'、'none'。'always' 一直显示 ,'hover' 鼠标移动上去显示 , 'none' 不显示
direction String 'all' 可滚动的方向。可填写的值有'all'、'x'、'y'。'all'垂直水平方向都可以滚动,'x'只可以在横向滚动,'y'只可以在垂直方向上滚动。
vBarStyle Object {'background-color': ''} 垂直方向上轨道样式设置。修改垂直方向上轨道的样式
hBarStyle Object {'background-color': ''} 水平方向上轨道样式设置。修改水平方向上轨道的样式
vThumbStyle Object {'background-color': 'rgba(0, 0, 0, 0.2)'} 垂直方向上滑块样式设置。修改垂直方向上滑块滑块的样式
hThumbStyle Object {'background-color': 'rgba(0, 0, 0, 0.2)'} 水平方向上滑块样式设置。修改水平方向上滑块滑块的样式

注:同时设置maxHeight、height或maxWidth、width,以较小者生效,尽量避免同事设置

三、方法
方法名 参数类型 说明
setScrollTop number 调用方式 setScrollTop(scrollTop)
setScrollLeft number 调用方式 setScrollLeft(scrollLeft)
四、事件
事件名 说明
scroll 滚动时触发
五、参考实例:



  




更多例子:参考src文件夹中example中的.vue文件

六、实现核心思路
  1. 通过MutationObserver、window.resize监听div元素内容或属性改变、监听窗口改变去更新滚动条滑块高度
  2. 通过::-webkit-scrollbar(谷歌、Edge)、 scrollbar-width: none;-ms-overflow-style: none;(火狐)隐藏原生滚动条
  3. 通过监听原生scroll事件去改变滑块的高度
  4. 点击轨道或拖动滑块时,监听mousedown事件去改变外层wrap的scrollTop或scrollLeft值。(改变此值会触发scroll事件)

你可能感兴趣的:(基于vue3的滚动条组件)