vue happy scroll
Chrome | Firefox | Safari | Edge | IE |
---|---|---|---|---|
√ | √ | √ | √ | 9 √10 √11 √ |
当前版本不支持移动端(还未在移动端进行过测试)。The current version not support SP(I haven't tested it on the smartphone yet).
Feature:
- 保留原生滚动条功能
- 支持动态设置滚动条颜色
- 支持设置滚动条的位置。左右(竖向滚动条)、上下(横向滚动)方向
- 支持隐藏滚动条
- 支持动态设定滚动位置,并支持top与left值同步
- 支持动态数据resize,滚动条自动隐藏与显示
- 支持设置resize滚动条变化规则(e. 在chart应用中,来新消息时,滚动条始终在最底部)
- 支持设置滚动速度
- 支持设置隐藏滚动条,hover时显示
Demo 地址
https://tangdaohai.github.io/vue-happy-scroll/
vue-happy-scroll 是干嘛的
vue-happy-scroll
是一款基于vue2.0的滚动条插件。
此插件致力解决原生滚动条在不同系统、不同浏览器中的丑陋表现,在保证原生滚动条功能可用的基础上实现了更丰富的功能、保证在所支持的浏览器下展现出风格一致、交互体验一致的滚动条。
它可以让你无需关心滚动条的兼容性问题,无需关心内容区域
的宽高,当设定resize
属性后,可以根据内容大小自动显示或隐藏滚动条
。
这里有对各种丰富的额外功能进行说明。
版本迭代计划列表
https://github.com/tangdaohai/vue-happy-scroll/projects/1
安装
- npm
推荐使用
npm
,这样可以跟随你的webpack
配置去选择怎样打包。
npm i -D vue-happy-scroll
-
CDN
当前是使用的https://unpkg.com托管CDN,unpkg会自动与
npm
中版本保持同步。通过以下方式引入即可:
<!-- 引入css,该链接始终为最新版的资源 --><!-- 引入vue --><!-- 引入组件,该链接始终为最新版的资源 -->可以访问https://unpkg.com/vue-happy-scroll/ 来选择不同版本
注册组件
-
全局注册
<template><happy-scroll><!-- 你的内容 --></happy-scroll></template><script>import Vue from 'vue'import HappyScroll from 'vue-happy-scroll'// 引入cssimport 'vue-happy-scroll/docs/happy-scroll.css'Vue.use(HappyScroll)//或者import { HappyScroll } from 'vue-happy-scroll'//自定义组件名Vue.component('happy-scroll', HappyScroll)</script> -
局部注册
<template><happy-scroll><!-- 你的内容 --></happy-scroll></template><script>import { HappyScroll } from 'vue-happy-scroll'// 引入css,推荐将css放入main入口中引入一次即可。import 'vue-happy-scroll/docs/happy-scroll.css'export default {name: '',components: {HappyScroll} //在组件内注册}</script> -
当
vue
是全局变量时//如果vue是全局变量,happyScroll自动全局安装。if typeof window !== 'undefined' && windowVueVue<!-- 你的内容 -->
属性
color
-
类型
String
-
默认值
rgba(51,51,51,0.2)
-
用法:
<!-- 你的内容 -->设置滚动条的颜色
建议使用
rgba
,这样可以为滚动条设置透明度,当然,如果你需要设置透明度的话。
size
-
类型
Number|String
-
默认值
4
-
用法:
<!-- 你的内容 -->设置滚动条的大小。
对于竖向滚动条表示宽度,横向滚动条表示高度
min-length-h (*new)
-
类型
Number
-
默认值
40
-
单位
px
-
用法
<!-- 你的内容 -->设置
横向
滚动条最小的长度,当元素无限长或者宽的时候,会导致滚动条无限小,这种情况可以使用该属性。来设置最小的长度。<!-- 你的内容 -->也可以设置
百分比
来限制最小长度(可视区域 * min-length-h)。假设可视区域的宽度为300px
,那么滚动条为60px
。当
min-length-h
小于1
的时候,会将其当作百分比
来处理。
min-length-v (*new)
-
类型
NUmber
-
默认值
40
-
单位
px
-
用法
<!-- 你的内容 -->设置
竖向
滚动条最小的长度,当元素无限长或者宽的时候,会导致滚动条无限小,这种情况可以使用该属性。来设置最小的长度。<!-- 你的内容 -->也可以设置
百分比
来限制最小长度(可视区域 * min-length-v)。假设可视区域的高度为200px
,那么滚动条为40px
。当
min-length-h
小于1
的时候,会将其当作百分比
来处理。
scroll-top
-
类型
Number|String
-
默认值
0
-
修饰符
sync
-
用法:
<!-- 你的内容 --><!-- 也可以增加 .sync 保持scroll-top同步 -->在组件
mounted
之后,设置容器
距离顶部的距离。相当于
element.scrollTop
一致。scroll-top
的值会自动转换为数字,所以当值为固定的数字时(使用+
转换的),你无需增加:(v-bind)
,直接写为scroll-top="20"
即可。
scroll-left
-
类型
Number|String
-
默认值
0
-
修饰符
sync
-
用法:
<!-- 你的内容 --><!-- 也可以增加 .sync 保持scroll-left -->在组件
mounted
之后,设置容器
距离左边的距离。相当于
element.scrollLeft
一致。
hide-vertical
-
类型
Boolean
-
默认值
false
-
用法:
<!-- 表示隐藏竖向滚动条 --><!-- 你的内容 -->隐藏
竖向
滚动条
hide-horizontal
-
类型
Boolean
-
默认值
false
-
用法:
<!-- 表示隐藏横向滚动条 --><!-- 你的内容 -->隐藏
横向
滚动条如果你不需要横向出现滚动条,可以设置hide-horizontal来提高性能。
resize
-
类型
Boolean
-
默认值
false
-
用法:
<!-- 表示开启监听容器大小变化 --><!-- 你的内容 -->如果
你的容器
大小是变化的(高度
或者宽度
可能随时发生变化的情况),可使用resize
来开启对容器大小变化的监听,当容器
的宽高
大于你设定的宽高
时,会自动出现滚动条,反正会自动隐藏滚动条。此功能当前版本依赖 element-resize-detector,目前正在寻找性能更高的办法,当然此插件的性能还是可以肯定的
smaller-move-h、smaller-move-v
-
类型
String
-
默认值
''
-
可选值:
start
end
- 除
1、2
的值之外,其他所有值都认为是默认值
-
用法:
<!-- 你的内容 -->当
resize=true
时,此配置才有效。该属性表示当容器
变小
时,滚动条移动的方向。- smaller-move-h 内容变小时,
横向
滚动条移动的方向 - smaller-move-v 内容变小时,
竖向
滚动条移动的方向
当设置为
start
时,表示变小之后,滚动条会移动到头部
(对竖向
滚动条来说是最上边
,对横向
滚动条来说是最左边
)当设置为
end
时,表示变小之后,滚动条会移动到尾部
(对竖向
滚动条来说是最下边
,对横向
滚动条来说是最右边
)当设置为
''
(默认值)时,表示在变小时,滚动条的位置不发生变化。 - smaller-move-h 内容变小时,
bigger-move-h、bigger-move-v
-
类型
String
-
默认值
''
-
可选值:
start
end
- 除
1、2
的值之外,其他所有值都认为是默认值
-
用法:
<!-- 你的内容 -->当
resize=true
时,此配置才有效。该属性表示当容器大小
变大
时,滚动条移动的方向。属性值与
smaller-move-h
原理一致。
left
-
类型
Boolean
-
默认值
false
-
用法:
<!-- 你的内容 -->表示设置
竖向
滚动条依靠在左
边。默认竖向滚动条在右边。
top
-
类型
Boolean
-
默认值
false
-
用法:
<!-- 你的内容 -->表示设置
横向
滚动条依靠在上
边。默认横向滚动条在下边。v
throttle
-
类型
Number
-
默认值
14
-
单位
毫秒
-
说明:
设置鼠标拖动滚动条的节流时间,如果没有特殊的要求不建议修改此值。
事件
horizontal-start
-
参数
scrollLeft
在
horizontal-start
事件下,scrollLeft
始终为0
。 -
说明 监听横向滚动条滚动到
头部
的事件。当scroll-left = 0
时会触发该事件。<!-- 你的内容 -->
horizontal-end
-
参数
scrollLeft
-
说明 监听横向滚动条滚动到
尾部
的事件。<!-- 你的内容 -->
vertical-start
-
参数
scrollTop
在
vertical-start
事件下,scrollTop
始终为0
-
说明 监听竖向滚动条滚动到
头部
的事件。当scroll-top = 0
时会触发该事件。<!-- 你的内容 -->
vertical-end
-
参数
scrollTop
-
说明 监听竖向滚动条滚动到
尾部
的事件。<!-- 你的内容 -->
PR
期待并欢迎您的PR。
但请您一定要遵守standard代码风格规范。
并且您只需要提交src
目录下的源码即可,无需
提交build
之后的代码
MIT
Copyright (c) 2017-present, 唐道海