vue2-scroll-box/website/components/scroll-box.md

A vue scroll box component, support pull-down and pull-up event, support interaction by both mouse and touch.

# scroll-box

## Props

<!-- @vuese:scroll-box:props:start -->
|Name|Description|Type|Required|Default|
|---|---|---|---|---|
|dragDistance|拖拽阈值，超过该值后释放将触发下拉或上拉事件|`Number`|`false`|150|
|enableDragDown|是否允许下拉|`Boolean`|`false`|false|
|enableDragUp|是否允许上拉|`Boolean`|`false`|false|
|enableTopButton|是否使用返回顶部按钮|`Boolean`|`false`|true|
|beforeText|下拉刷新提示文本|`String`|`false`|'Release and reload'|
|afterText|上拉加载更多提示文本|`String`|`false`|'Release and load more'|
<!-- @vuese:scroll-box:props:end -->


## Events

<!-- @vuese:scroll-box:events:start -->
|Event Name|Description|Parameters|
|---|---|---|
|box-scroll|Fire when the scroll box is scrolling|-|
|pull-down|触发下拉刷新|-|
|pull-up|触发上拉加载更多|-|
<!-- @vuese:scroll-box:events:end -->


## Slots

<!-- @vuese:scroll-box:slots:start -->
|Name|Description|Default Slot Content|
|---|---|---|
|dragDownArea|-|-|
|default|-|-|
|dragUpArea|-|-|
<!-- @vuese:scroll-box:slots:end -->


## Methods

<!-- @vuese:scroll-box:methods:start -->
|Method|Description|Parameters|
|---|---|---|
|disableScroll|禁用滚动|-|
|enableScroll|启用滚动|-|
|scrollUpdate|下拉刷新或上拉加载更多后须执行滚动盒子实例的 scrollUpdate 方法更新状态this.$refs.scrollInstance.scrollUpdate()|contentUpdate {boolean} 盒子内容是否有更新|
|scrollTo|滚动至指定位置或元素|top 滚动至何处，object为dom对象，string为选择器，number为像素offset 滚动偏移|
<!-- @vuese:scroll-box:methods:end -->