Skip to content

Commit 4dacddb

Browse files
committed
update readme.md
1 parent 041d1e7 commit 4dacddb

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# react-native-SmartRefreshLayout[![npm version](https://badge.fury.io/js/react-native-smartrefreshlayout.svg)](https://badge.fury.io/js/react-native-smartrefreshlayout)
1+
# react-native-SmartRefreshLayout(完全可使用RN自定义的下拉刷新插件)[![npm version](https://badge.fury.io/js/react-native-smartrefreshlayout.svg)](https://badge.fury.io/js/react-native-smartrefreshlayout)
22
基于android SmartRefreshLayout https://github.com/scwang90/SmartRefreshLayout 开发的插件,可提供类似ios的弹性刷新、加载,如果你喜欢,请不要吝啬你的 :smile: star :smile:
33
## 第一步
44
工程目录下运行 `npm install --save react-native-smartrefreshlayout` 或者 `yarn add react-native-smartrefreshlayout`(已经安装了yarn)
@@ -29,15 +29,29 @@ import {SmartRefreshControl,ClassicsHeader,StoreHouseHeader,DefaultHeader} from
2929
|属性名|类型|描述|
3030
|:---:|:---:|:---:|
3131
|onRefresh|func|刷新触发|
32+
|onPullDownToRefresh|func|可下拉刷新时触发|
33+
|onReleaseToRefresh|func|可释放刷新时触发|
34+
|onHeaderPulling|func|header下拉过程触发|
35+
|onHeaderReleasing|func|header释放过程触发|
3236
|enableRefresh|bool|是否启用刷新|
37+
|headerHeight|number|设置Header的高度|
38+
|primaryColor|string|刷新控件主调色|
39+
|autoRefresh|{refresh,timeout}|设置自动刷新|
3340
|HeaderComponent|Component|refreshcontrol的header|
3441

35-
注意:HeaderComponet现在只能是插件提供的Header,后续我们将改进与提供任何Component
42+
注意:HeaderComponet现在支持任意的RN组件,但是需要放在AnyHeader的组件中,其中onHeaderPulling和onHeaderReleasing的参数为{nativeEvent:{percent,offset,headerHeight}},可用来控制下拉和释放过程中更为精细的动画
43+
如果下拉和释放过程不需要过程动画,则使用onPullDownToRefresh和onReleaseToRefresh即可实现,请看示例:Example
3644
#### 方法表格
3745
|方法名|参数|描述|
3846
|:---:|:---:|:---:|
3947
|finishRefresh|{delayed:number,success:bool}|完成刷新|
4048

49+
### AnyHeader
50+
#### 属性表格
51+
|属性名|类型|描述|
52+
|:---:|:---:|:---:|
53+
|primaryColor|string|主题色|
54+
4155
### ClassicsHeader/DefaultHeader
4256
#### 属性表格
4357
|属性名|类型|描述|

0 commit comments

Comments
 (0)