blear.classes.scrollable

1Introduction

2Example

var Scrollable = require('blear.class.scrollable');

var scrollable = new Scrollable();

3Static

3.1.defaults

3.1.1.defaults.el

  • 类型:HTMLElement | String | null
  • 说明:滚动的容器元素
  • 默认:null

3.1.2.defaults.offsetX

  • 类型:Number
  • 说明:水平偏移值
  • 默认:20

3.1.3.defaults.offsetY

  • 类型:Number
  • 说明:垂直偏移值
  • 默认:20

4new Scrollable(options)

实例化一个可滚动区域。options 的默认值为 defaults

5Prototype

原型属性、方法

5.1#update(): Scrollable

更新位置信息

scrollable.update();

5.1.1Scrollable

  • 类型:Scrollable
  • 说明:支持链式调用

5.2#enable(): Scrollable

设置滚动期间监听

scrollable.enable();

5.2.1Scrollable

  • 类型:Scrollable
  • 说明:支持链式调用

5.3#disable(): Scrollable

设置滚动期间不监听

scrollable.disable();

5.3.1Scrollable

  • 类型:Scrollable
  • 说明:支持链式调用

5.4#destroy(): undefined

销毁实例

scrollable.destroy();

6Events

  • 所有的事件都兼容手机,在手机上监听 touch 实现。
  • 滚动方向参考滚动的方向。即向下滚动,滚动条向下走,但内容却向上走。

6.1scrollTop(meta)

滚动到顶部触发。

6.1.1meta

以下 meta 的参数都一致。

6.1.2meta.scrollLeft

  • 类型:Number
  • 说明:滚动左距离

6.1.3meta.scrollTop

  • 类型:Number
  • 说明:滚动上距离

6.1.4meta.maxScrollLeft

  • 类型:Number
  • 说明:最大滚动左距离

6.1.5meta.maxScrollTop

  • 类型:Number
  • 说明:最大滚动上距离

6.2scrollBottom(meta)

滚动到底部触发。

6.3scrollLeft(meta)

滚动到左边界触发。

6.4scrollRight(meta)

滚动到右边界触发。

6.5scrollUp(meta)

向上滚动触发。

6.6scrollDown(meta)

向下滚动触发。

6.7scrollPush(meta)

向右滚动触发。

6.8scrollPull(meta)

向左滚动触发。

6.9scroll(meta)

滚动过程中触发。

7Dependencies