Z-scrollbar NPM

ZScrollbar 自定义滚动条

===

Chrome	Firefox	Safari	Edge	IE
√	√	√	√	`9` √`10` √`11` √

当前版本不支持移动端(还未在移动端进行过测试)。The current version not support SP(I haven't tested it on the smartphone yet).

Feature:

保留原生滚动条功能
支持动态设置滚动条颜色
支持设置滚动条的位置。左右(竖向滚动条)、上下(横向滚动)方向
支持隐藏滚动条
支持 hover 显示滚动条
支持动态设定滚动位置，并支持 top 与 left 值同步
支持动态数据 resize，滚动条自动隐藏与显示
支持设置 resize 滚动条变化规则(e. 在 chart 应用中，来新消息时，滚动条始终在最底部)
支持设置滚动速度
支持设置隐藏滚动条，hover 时显示

ZScrollbar 是干嘛的

ZScrollbar是一款基于 vue2.0 的滚动条插件。

此插件致力解决原生滚动条在不同系统、不同浏览器中的丑陋表现，在保证原生滚动条功能可用的基础上实现了更丰富的功能、保证在所支持的浏览器下展现出风格一致、交互体验一致的滚动条。

它可以让你无需关心滚动条的兼容性问题，无需关心内容区域的宽高，当设定resize属性后，可以根据内容大小自动显示或隐藏滚动条。

安装

npm i  ZScrollbar

or

yarn add ZScrollbar

注册组件

全局注册

<template>
  <z-scrollbar>
    <!-- 你的内容 -->
  </z-scrollbar>
</template>
<script>
import Vue from 'vue'

import ZScrollbar from 'ZScrollbar'

Vue.use(ZScrollbar)
</script>

局部注册

<template>
  <z-scrollbar>
    <!-- 你的内容 -->
  </z-scrollbar>
</template>
<script>
import ZScrollbar from 'ZScrollbar'
// 引入css，推荐将css放入main入口中引入一次即可。
import 'ZScrollbar/docs/z-scrollbar.css'
export default {
  name: '',
  components: { [ZScrollbar.name]: ZScrollbar } //在组件内注册
}
</script>

属性

color

类型String
默认值rgba(51,51,51,0.2)
用法:
```
<z-scrollbar color="rgba(51,51,51,0.2)">
  
</z-scrollbar>
```
设置滚动条的颜色
建议使用rgba，这样可以为滚动条设置透明度，当然，如果你需要设置透明度的话。

size

类型Number|String
默认值4
用法:
```
<z-scrollbar size="8">
  
</z-scrollbar>
```
设置滚动条的大小。
对于竖向滚动条表示宽度，横向滚动条表示高度

min-length-h (*new)

类型Number
默认值40
单位px
用法
```
<z-scrollbar :min-length-h="20">
  
</z-scrollbar>
```
设置横向滚动条最小的长度，当元素无限长或者宽的时候，会导致滚动条无限小，这种情况可以使用该属性。来设置最小的长度。
```
<z-scrollbar :min-length-h="0.2">
  
</z-scrollbar>
```
也可以设置百分比来限制最小长度(可视区域 * min-length-h)。假设可视区域的宽度为300px，那么滚动条为60px。
当min-length-h小于1的时候，会将其当作百分比来处理。

min-length-v (*new)

类型NUmber
默认值40
单位px
用法
```
<z-scrollbar :min-length-v="20">
  
</z-scrollbar>
```
设置竖向滚动条最小的长度，当元素无限长或者宽的时候，会导致滚动条无限小，这种情况可以使用该属性。来设置最小的长度。
```
<z-scrollbar :min-length-v="0.2">
  
</z-scrollbar>
```
也可以设置百分比来限制最小长度(可视区域 * min-length-v)。假设可视区域的高度为200px，那么滚动条为40px。
当min-length-h小于1的时候，会将其当作百分比来处理。

scroll-top

类型Number|String
默认值0
修饰符sync
用法:
```
<z-scrollbar scroll-top="20">
  
</z-scrollbar>

<z-scrollbar scroll-top.sync="20"></z-scrollbar>
```
在组件mounted之后，设置容器距离顶部的距离。
相当于element.scrollTop 一致。
scroll-top的值会自动转换为数字，所以当值为固定的数字时(使用+转换的)，你无需增加:(v-bind)，直接写为scroll-top="20"即可。

scroll-left

类型Number|String
默认值0
修饰符sync

用法:

<z-scrollbar scroll-left="20">
  <!-- 你的内容 -->
</z-scrollbar>
<!-- 也可以增加 .sync 保持scroll-left -->
<z-scrollbar scroll-top.left="20"></z-scrollbar>

在组件mounted之后，设置容器距离左边的距离。

相当于element.scrollLeft 一致。

hide-vertical

类型 Boolean
默认值 false

用法:

<!-- 表示隐藏竖向滚动条 -->
<z-scrollbar hide-vertical>
  <!-- 你的内容 -->
</z-scrollbar>

隐藏竖向滚动条

hide-horizontal

类型 Boolean
默认值 false
用法:
```

<z-scrollbar hide-horizontal>
  
</z-scrollbar>
```
隐藏横向滚动条
如果你不需要横向出现滚动条，可以设置 hide-horizontal 来提高性能。

hoverScroll

类型 Boolean
默认值 false

用法:

<!-- 表示隐藏横向滚动条 -->
<z-scrollbar hover-scroll>
  <!-- 你的内容 -->
</z-scrollbar>

hover 时显示滚动条

resize

类型Boolean
默认值false
用法:
```

<z-scrollbar resize>
  
</z-scrollbar>
```
如果你的容器大小是变化的(高度或者宽度可能随时发生变化的情况)，可使用resize来开启对容器大小变化的监听，当容器的宽高大于你设定的宽高时，会自动出现滚动条，反正会自动隐藏滚动条。
此功能当前版本依赖 element-resize-detector，目前正在寻找性能更高的办法，当然此插件的性能还是可以肯定的

smaller-move-h、smaller-move-v

类型String
默认值''
可选值:
1. start
2. end
3. 除1、2的值之外，其他所有值都认为是默认值
用法:
```
<z-scrollbar smaller-move-v="start">
  
</z-scrollbar>
```
当resize=true时，此配置才有效。
该属性表示当容器变小时，滚动条移动的方向。
- smaller-move-h 内容变小时，横向滚动条移动的方向
- smaller-move-v 内容变小时，竖向滚动条移动的方向
当设置为start时，表示变小之后，滚动条会移动到头部(对竖向滚动条来说是最上边，对横向滚动条来说是最左边)
当设置为end时，表示变小之后，滚动条会移动到尾部(对竖向滚动条来说是最下边，对横向滚动条来说是最右边)
当设置为''(默认值)时，表示在变小时，滚动条的位置不发生变化。

bigger-move-h、bigger-move-v

类型String
默认值''
可选值:
1. start
2. end
3. 除1、2的值之外，其他所有值都认为是默认值
用法:
```
<z-scrollbar bigger-move-h="start">
  
</z-scrollbar>
```
当resize=true时，此配置才有效。
该属性表示当容器大小变大时，滚动条移动的方向。
属性值与smaller-move-h原理一致。

left

类型Boolean
默认值false
用法:
```
<z-scrollbar left>
  
</z-scrollbar>
```
表示设置竖向滚动条依靠在左边。默认竖向滚动条在右边。

top

类型Boolean
默认值false
用法:
```
<z-scrollbar top>
  
</z-scrollbar>
```
表示设置横向滚动条依靠在上边。默认横向滚动条在下边。v

throttle

类型Number
默认值14
单位毫秒
说明:
设置鼠标拖动滚动条的节流时间，如果没有特殊的要求不建议修改此值。

Events

horizontal-start

参数scrollLeft
在horizontal-start事件下，scrollLeft始终为0。
说明监听横向滚动条滚动到头部的事件。当scroll-left = 0时会触发该事件。
```
<z-scrollbar @horizontal-start="yourHandler">
  
</z-scrollbar>
```

horizontal-end

参数scrollLeft

说明监听横向滚动条滚动到尾部的事件。

<z-scrollbar @horizontal-end="yourHandler">
  <!-- 你的内容 -->
</z-scrollbar>

vertical-start

参数scrollTop
在vertical-start事件下，scrollTop始终为0
说明监听竖向滚动条滚动到头部的事件。当scroll-top = 0时会触发该事件。
```
<z-scrollbar @vertical-start="yourHandler">
  
</z-scrollbar>
```

vertical-end

参数scrollTop

说明监听竖向滚动条滚动到尾部的事件。

<z-scrollbar @vertical-end="yourHandler">
  <!-- 你的内容 -->
</z-scrollbar>

scroll

参数scroll
在scroll事件下，返回的结果是滚动的数据。

说明监听滚动条滚动事件。

<z-scrollbar @scroll="yourHandler">
  <!-- 你的内容 -->
</z-scrollbar>

Methods

resetScrollTop 设置垂直方向滚动条位置

参数 num 默认值为 0

resetScrollLeft 设置水平方向滚动条位置

参数 num 默认值为 0

vue vuejs component scrollbar

element-resize-detector

@everything-registry/sub-chunk-3218

5 years ago

5 years ago

5 years ago

5 years ago