From 17a830a1eeea379e8be0acd957eb3e86dd4eacd6 Mon Sep 17 00:00:00 2001 From: StackJIE Date: Sun, 13 Aug 2017 20:11:21 +0800 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 628447e..fc0d586 100644 --- a/README.md +++ b/README.md @@ -54,9 +54,9 @@ A pull-down refresh and pull-up load more and infinite scroll of the vue.js comp } ``` -组件会默认占据父元素的百分之百高度。props `top-load-method`和`bottom-load-method`会默认传进一个`loaded`参数，该参数是一个改变组件加载状态的函数，必须调用一次`loaded`不然组件就会一直处于加载状态，如果执行`loaded('done')`组件内部状态就会变成成功加载的状态，`loaded('fail')`为失败。 +组件会默认占据父元素的百分之百高度。props `top-load-method`和`bottom-load-method`会默认传进一个`loaded`参数，该参数是一个改变组件加载状态的函数，必须调用一次`loaded`不然组件就会一直处于加载状态，如果执行`loaded('done')`组件内部状态就会变成成功加载的状态，`loaded('fail')`为失败。 -[更多使用示例请参考Examples的代码](https://github.com/stackjie/vue-pull-to/tree/master/examples) +[更多使用示例请参考Examples的代码](https://github.com/stackjie/vue-pull-to/tree/master/examples) ## API Docs @@ -64,24 +64,24 @@ A pull-down refresh and pull-up load more and infinite scroll of the vue.js comp | 属性 | 说明 | 类型 | 默认值 | | --- | --- | --- | --- | | distance-index | 滑动的阀值（值越大滑动的速度越慢） | Number | 2 | -| top-block-height | 顶部在滚动容器外的块级元素区域高度 | Number | 50 | -| bottom-block-height | 底部在滚动容器外的块级元素区域高度 | Number | 50 | +| top-block-height | 顶部在滚动容器外的块级元素区域高度 | Number | 50 | +| bottom-block-height | 底部在滚动容器外的块级元素区域高度 | Number | 50 | | top-load-method | 顶部下拉时执行的方法 | Function | | | bottom-load-method | 底部上拉时执行的方法 | Function | | -| is-throttle | 是否截流`top-pull`和`bottom-pull`自定义事件的触发以保证性能 | Boolean | true | +| is-throttle | 是否截流`top-pull`和`bottom-pull`自定义事件的触发以保证性能 | Boolean | true | | top-config | 滚动容器顶部信息的一些配置 | Object | 默认配置 | | bottom-config | 滚动容器底部信息的一些配置 | Object | 默认配置 | -`topConfig`和`bottomConfig`可配置的选项和默认配置项的值 +`topConfig`和`bottomConfig`可配置的选项和默认配置项的值 ``` javascript const TOP_DEFAULT_CONFIG = { - pullText: '下拉刷新', // 下拉时显示的文字 + pullText: '下拉刷新', // 下拉时显示的文字 triggerText: '释放更新', // 下拉到触发距离时显示的文字 loadingText: '加载中...', // 加载中的文字 doneText: '加载完成', // 加载完成的文字 failText: '加载失败', // 加载失败的文字 loadedStayTime: 400, // 加载完后停留的时间ms - stayDistance: 50, // 触发刷新后停留的距离 + stayDistance: 50, // 触发刷新后停留的距离 triggerDistance: 70 // 下拉刷新触发的距离 } @@ -97,17 +97,17 @@ const BOTTOM_DEFAULT_CONFIG = { } ``` ### slots -| 名称 | 说明 | scope | +| 名称 | 说明 | scope | | --- | --- | --- | | default | 默认slot滚动容器的内容 | -| top-block | 滚动容器外顶部的内容（支持作用域slot需用`template`标签加上`scope`属性）| `state`：当前的状态、`state-text`：状态对应的文本 | -| bottom-block | 滚动容器外底部的内容（支持作用域slot需用`template`标签加上`scope`属性）| `state`：当前的状态、`state-text`：状态对应的文本 | +| top-block | 滚动容器外顶部的内容（支持作用域slot需用`template`标签加上`scope`属性）| `state`：当前的状态、`state-text`：状态对应的文本 | +| bottom-block | 滚动容器外底部的内容（支持作用域slot需用`template`标签加上`scope`属性）| `state`：当前的状态、`state-text`：状态对应的文本 | ### events | 事件名 | 说明 | | --- | --- | -| top-state-change | 顶部状态发生了改变时触发，第一个参数为当前的状态 | -| bottom-state-change | 底部状态发生了改变时触发，第一个参数为当前的状态 | -| top-pull | 下拉时触发，第一个参数为当前拉动的距离值，默认会被截流，可配置props `isThrottle`来实时触发 | -| bottom-pull | 上拉时触发，第一个参数为当前拉动的距离值，默认会被截流，可配置props `isThrottle`来实时触发 | -| infinite-scroll | 当滚动容器滚动到底部时触发 | +| top-state-change | 顶部状态发生了改变时触发，第一个参数为当前的状态 | +| bottom-state-change | 底部状态发生了改变时触发，第一个参数为当前的状态 | +| top-pull | 下拉时触发，第一个参数为当前拉动的距离值，默认会被截流，可配置props `isThrottle`来实时触发 | +| bottom-pull | 上拉时触发，第一个参数为当前拉动的距离值，默认会被截流，可配置props `isThrottle`来实时触发 | +| infinite-scroll | 当滚动容器滚动到底部时触发 |