1.1.7 • Published 5 years ago

haku-scroll v1.1.7

Weekly downloads
13
License
MIT
Repository
github
Last release
5 years ago

haku-scroll Build Status npm.io npm.io npm.io npm.io npm.io

vue滚动条组件

示例图

示例DEMO

说明

:smiley: 一款定制化滚动条,目前仅兼容PC端,兼容性为IE9+,之后会考虑增加移动端的滚动功能。

示例具体可参考 App.vue页面

安装

npm install haku-scroll --save

引入

//全局注册组件
import hakuScroll from 'haku-scroll'
Vue.use(hakuScroll)

//单组件引用
import hakuScroll from 'haku-scroll'
new Vue({
    components: { ...hakuScroll }
})

区域 haku-block

组件调用

<haku-block>
...
</haku-block>

属性

属性名类型默认值描述
contentClassString-内容class样式
contentStyleString-内容style样式
animeBooleantrue是否启用平滑移动效果
wheelstepNumber100单步鼠标滚动距离
wheeltimeNumber200单步鼠标滚动时间
wheelseaingString'sineOut'滚动时的运动曲线,参考 liike
verticalBooleantrue纵向滚动条是否展现
horizontalBooleanfalse横向滚动条是否展现
watchSubTreeBooleanfalse是否监听子节点树
parentScrollBooleanfalsewheel滚动事件延伸至父容器
hideButtonBooleantrue隐藏按钮

函数

函数名参数返回值描述
scrollTo{ x:Number,y:Numbere,anime:Boolean,... }-滚动到某处
refreshconfig-刷新/重置滚动条基本属性
getScrollTop-Number获取距离视窗顶部的像素
getScrollLeft-Number获取距离视窗左边缘的像素

事件

事件名返回参数描述
oninit-组件初始化
ondestroy-组件销毁

滚动条 haku-scroll

组件调用

<haku-scroll :value.sync="value" :max-value="maxvalue">
...
</haku-scroll>

属性

属性名类型默认值描述
disabledBooleanfalse是否禁用
hiddenBooleanfalse是否隐藏
typeString-滚动条类型(vertical/horizontal)
minNumber0可操作最小值
maxNumber0可操作最大值(0为不设最大值)
stepNumber0步长(0为不设步长)
sizeNumber-滚动条滑块大小
valueNumber0滚动条滚动的值
maxValueNumber-最大值
minValueNumber0最小值
hideBtnBooleantrue隐藏按钮

函数

函数名参数返回值描述
scrollTovalue, isAdd = false-滚动到某处
refresh--刷新/重置滚动条基本属性

事件

事件名返回参数描述
oninit-组件初始化
ondestroy-组件销毁

未完成功能

  • 基本功能
  • 变化监听
  • 鼠标中键滚动
  • 自定义滚动条样式
  • 支持TypeScript
  • 自动隐藏
  • 滚动限制
  • 滚动事件钩子
  • 禁用
  • 扩展至移动端
  • 拆分为独立js组件
  • 自定义工具按钮
1.1.7

5 years ago

1.1.6

5 years ago

1.1.5

5 years ago

1.1.4

5 years ago

1.1.3

5 years ago

1.1.2

5 years ago

1.1.1

5 years ago

1.1.0

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago