Skip to content
This repository has been archived by the owner. It is now read-only.

Commit 17a830a

Browse files
authored
Update README.md
1 parent 0097739 commit 17a830a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -54,34 +54,34 @@ A pull-down refresh and pull-up load more and infinite scroll of the vue.js comp
5454
}
5555
</script>
5656
```
57-
组件会默认占据父元素的百分之百高度。props `top-load-method`和`bottom-load-method`会默认传进一个`loaded`参数,该参数是一个改变组件加载状态的函数,必须调用一次`loaded`不然组件就会一直处于加载状态,如果执行`loaded('done')`组件内部状态就会变成成功加载的状态,`loaded('fail')`为失败。
57+
组件会默认占据父元素的百分之百高度。props `top-load-method``bottom-load-method`会默认传进一个`loaded`参数,该参数是一个改变组件加载状态的函数,必须调用一次`loaded`不然组件就会一直处于加载状态,如果执行`loaded('done')`组件内部状态就会变成成功加载的状态,`loaded('fail')`为失败。
5858

59-
[更多使用示例请参考Examples的代码](https://github.com/stackjie/vue-pull-to/tree/master/examples)
59+
[更多使用示例请参考Examples的代码](https://github.com/stackjie/vue-pull-to/tree/master/examples)
6060

6161
## API Docs
6262

6363
### props
6464
| 属性 | 说明 | 类型 | 默认值 |
6565
| --- | --- | --- | --- |
6666
| distance-index | 滑动的阀值(值越大滑动的速度越慢) | Number | 2 |
67-
| top-block-height | 顶部在滚动容器外的块级元素区域高度 | Number | 50 |
68-
| bottom-block-height | 底部在滚动容器外的块级元素区域高度 | Number | 50 |
67+
| top-block-height | 顶部在滚动容器外的块级元素区域高度 | Number | 50 |
68+
| bottom-block-height | 底部在滚动容器外的块级元素区域高度 | Number | 50 |
6969
| top-load-method | 顶部下拉时执行的方法 | Function | |
7070
| bottom-load-method | 底部上拉时执行的方法 | Function | |
71-
| is-throttle | 是否截流`top-pull``bottom-pull`自定义事件的触发以保证性能 | Boolean | true |
71+
| is-throttle | 是否截流`top-pull``bottom-pull`自定义事件的触发以保证性能 | Boolean | true |
7272
| top-config | 滚动容器顶部信息的一些配置 | Object | 默认配置 |
7373
| bottom-config | 滚动容器底部信息的一些配置 | Object | 默认配置 |
7474

75-
`topConfig``bottomConfig`可配置的选项和默认配置项的值
75+
`topConfig``bottomConfig`可配置的选项和默认配置项的值
7676
``` javascript
7777
const TOP_DEFAULT_CONFIG = {
78-
pullText: '下拉刷新', // 下拉时显示的文字
78+
pullText: '下拉刷新', // 下拉时显示的文字
7979
triggerText: '释放更新', // 下拉到触发距离时显示的文字
8080
loadingText: '加载中...', // 加载中的文字
8181
doneText: '加载完成', // 加载完成的文字
8282
failText: '加载失败', // 加载失败的文字
8383
loadedStayTime: 400, // 加载完后停留的时间ms
84-
stayDistance: 50, // 触发刷新后停留的距离
84+
stayDistance: 50, // 触发刷新后停留的距离
8585
triggerDistance: 70 // 下拉刷新触发的距离
8686
}
8787

@@ -97,17 +97,17 @@ const BOTTOM_DEFAULT_CONFIG = {
9797
}
9898
```
9999
### slots
100-
| 名称 | 说明 | scope |
100+
| 名称 | 说明 | scope |
101101
| --- | --- | --- |
102102
| default | 默认slot滚动容器的内容 |
103-
| top-block | 滚动容器外顶部的内容(支持作用域slot需用`template`标签加上`scope`属性)| `state`:当前的状态、`state-text`:状态对应的文本 |
104-
| bottom-block | 滚动容器外底部的内容(支持作用域slot需用`template`标签加上`scope`属性)| `state`:当前的状态、`state-text`:状态对应的文本 |
103+
| top-block | 滚动容器外顶部的内容(支持作用域slot需用`template`标签加上`scope`属性)| `state`:当前的状态、`state-text`:状态对应的文本 |
104+
| bottom-block | 滚动容器外底部的内容(支持作用域slot需用`template`标签加上`scope`属性)| `state`:当前的状态、`state-text`:状态对应的文本 |
105105

106106
### events
107107
| 事件名 | 说明 |
108108
| --- | --- |
109-
| top-state-change | 顶部状态发生了改变时触发,第一个参数为当前的状态 |
110-
| bottom-state-change | 底部状态发生了改变时触发,第一个参数为当前的状态 |
111-
| top-pull | 下拉时触发,第一个参数为当前拉动的距离值,默认会被截流,可配置props `isThrottle`来实时触发 |
112-
| bottom-pull | 上拉时触发,第一个参数为当前拉动的距离值,默认会被截流,可配置props `isThrottle`来实时触发 |
113-
| infinite-scroll | 当滚动容器滚动到底部时触发 |
109+
| top-state-change | 顶部状态发生了改变时触发,第一个参数为当前的状态 |
110+
| bottom-state-change | 底部状态发生了改变时触发,第一个参数为当前的状态 |
111+
| top-pull | 下拉时触发,第一个参数为当前拉动的距离值,默认会被截流,可配置props `isThrottle`来实时触发 |
112+
| bottom-pull | 上拉时触发,第一个参数为当前拉动的距离值,默认会被截流,可配置props `isThrottle`来实时触发 |
113+
| infinite-scroll | 当滚动容器滚动到底部时触发 |

0 commit comments

Comments
 (0)