UIListView

close hide getIndex setSwipeBtns deleteItem insertItem getCount setRefreshFooter

论坛示例

为帮助用户更好更快的使用模块,论坛维护了一个,示例中包含示例代码、知识点讲解、注意事项等,供您参考。

概述

UIListView 模块封装了一个数据列表控件,列表项水平侧滑可出现控制按钮;开发者可自定义列表的数据源,及列表的样式,支持列表项的增、删、改、查,支持批量更新、追加数据,支持下拉刷新和上拉加载事件。UIListView 模块是 listView 模块的优化版。本模块的源码开源地址为:https://github.com/apicloudcom/UIListView

open

打开 UIListView 模块

open({params}, callback(ret, err))

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 备注:Android 必须传此参数。
  • 内部字段:

data:

  • 类型:数组
  • 描述:列表的数据源,开发者可以自定义唯一的键值对信息(如:uid: ‘1001’),供 getIndex 使用
  • 内部字段:
  1. imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
  2. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  3. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  4. remark: '', //(可选项)字符串类型;右边备注文字
  5. icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
  6. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件和侧滑露出按钮功能,屏蔽后的样式可通过 styles->forbidden参数配置
  7. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同下方 rightBtns 参数
  8. }]

rightBtns:

  • 类型:数组
  • 描述:(可选项)列表项向左滑动露出的按钮组,建议:配置列表每项的通用按钮,用此参数;配置某一项的特定按钮,可在 data 数组的指定项传入 rightBtns 参数
  • 内部字段:
  1. [{
  2. bgColor: '#388e8e', //(可选项)字符串类型;按钮背景色,支持 rgb、rgba、#;默认:'#388e8e'
  3. activeBgColor: '', //(可选项)字符串类型;按钮按下时的背景色,支持 rgb、rgba、#
  4. width: 70, //(可选项)数字类型;按钮的宽度;默认:w / 4
  5. title: '', //(可选项)字符串类型;按钮标题,水平、垂直居中
  6. titleSize: 12, //(可选项)数字类型;按钮标题文字大小;默认:12
  7. titleColor: '#fff', //(可选项)字符串类型;按钮标题文字颜色,支持 rgb、rgba、#;默认:'#ffffff'
  8. icon: '', //(可选项)字符串类型;按钮标题前的图标路径(本地路径,支持fs://、widget://),水平、垂直居中,图标为正方形
  9. iconWidth: 20 //(可选项)数字类型;按钮标题前的图标宽度,图标为正方形;默认:20
  10. }]

bounces:

  • 类型:布尔
  • 描述:(可选项)是否开启弹动,android 平台不支持本参数
  • 默认:false

styles:

  • 类型:JSON 对象
  • 描述:(可选项)模块各部分的样式
  • 内部字段:
  1. {
  2. borderColor: '#696969', //(可选项)字符串类型;列表分割线的颜色,支持 rgb、rgba、#;默认:'#696969'
  3. item: { //(可选项)JSON对象;列表项的样式
  4. bgColor: '#AFEEEE', //(可选项)字符串类型;列表项的背景色,支持 rgb、rgba、#;默认:'#AFEEEE'
  5. activeBgColor: '#F5F5F5', //(可选项)字符串类型;列表项按下时的背景色,支持 rgb、rgba、#;默认:'#F5F5F5'
  6. height: 55, //(可选项)数字类型;列表项的高度;默认:55
  7. imgWidth: 40, //(可选项)数字类型;列表项配图的宽度;默认:列表项的高度减去10px
  8. imgHeight: 40, //(可选项)数字类型;列表项配图的高度;默认:列表项的高度减去10px
  9. imgCorner: 4, //(可选项)数字类型;列表项配图的圆角大小;默认:0
  10. placeholderImg: '', //(可选项)字符串类型;列表项配图的占位图路径(本地路径,fs://、widget://),默认:APICloud 图标
  11. titleSize: 12, //(可选项)数字类型;列表项标题文字大小;默认:12
  12. titleColor: '#000', //(可选项)字符串类型;列表项标题文字颜色,支持 rgb,rgba,#;默认:'#000000'
  13. subTitleSize: 12, //(可选项)数字类型;列表项子标题文字大小;默认:12
  14. subTitleColor: '#000', //(可选项)字符串类型:列表项子标题文字颜色,支持 rgb、rgba、#;默认:'#000000'
  15. remarkColor: '#000', //(可选项)字符串类型;备注的文字颜色,支持 rgb、rgba、#;默认:'#000000'
  16. remarkSize: 16, //(可选项)数字类型;备注的文字大小;默认:16
  17. remarkIconWidth: 30 //(可选项)数字类型;当备注是图片时,图片的宽度,图片为正方形;默认:30
  18. },
  19. forbidden: { //(可选项)JSON对象;屏蔽点击事件的列表项的样式配置
  20. bgColor: '#B0C4DE', //(可选项)字符串类型;列表项背景色,支持rgb、#、rgba;默认:#C0C0C0
  21. titleColor: '800000', //(可选项)字符串类型;列表项标题色,支持rgb、#、rgba;默认:#808080
  22. subTitleColor: '#696969', //(可选项)字符串类型;列表项子标题色,支持rgb、#、rgba;默认:#808080
  23. remarkColor: '#FFDEAD', //(可选项)字符串类型;列表项备注色,支持rgb、#、rgba;默认:#808080
  24. sideslip: false //(可选项)布尔类型;是否只屏蔽侧滑;默认:false(侧滑和点击事件都屏蔽)
  25. }
  26. }

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认:模块依附于当前 window

showScrollBar:

  • 类型:布尔
  • 描述:(可选项)是否显示滚动条
  • 默认:true

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. eventType: 'show', //字符串类型;交互事件类型
  3. //取值范围如下:
  4. //show(模块加载成功)
  5. //clickRightBtn(点击侧滑出现的右侧按钮)
  6. //clickContent(点击列表项的内容,除了配图和备注以外的区域)
  7. //clickImg(点击列表项的配图)
  8. //clickRemark(点击列表项右侧备注)
  9. //longPress (列表长按事件)
  10. index: 0, //数字类型;列表项的索引
  11. btnIndex: 0 //数字类型;列表项侧滑出现的按钮的索引
  12. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.open({
  3. rect: {
  4. x: 0,
  5. y: 0,
  6. w: api.winWidth,
  7. h: api.frameHeight
  8. },
  9. data: [{
  10. uid: '1001',
  11. imgPath: 'widget://res/img/apicloud.png',
  12. title: '标题',
  13. subTitle: '子标题,说明文字',
  14. remark: '备注',
  15. icon: ''
  16. }, {
  17. uid: '1001',
  18. imgPath: 'widget://res/img/apicloud.png',
  19. title: '标题',
  20. subTitle: '子标题,说明文字',
  21. remark: '备注',
  22. icon: ''
  23. }, {
  24. uid: '1001',
  25. imgPath: 'widget://res/img/apicloud.png',
  26. title: '标题',
  27. subTitle: '子标题,说明文字',
  28. remark: '备注',
  29. icon: ''
  30. }, {
  31. uid: '1001',
  32. imgPath: 'widget://res/img/apicloud.png',
  33. title: '标题',
  34. subTitle: '子标题,说明文字',
  35. remark: '备注',
  36. icon: ''
  37. }, {
  38. uid: '1001',
  39. imgPath: 'widget://res/img/apicloud.png',
  40. title: '标题',
  41. subTitle: '子标题,说明文字',
  42. remark: '备注',
  43. icon: ''
  44. }, {
  45. uid: '1001',
  46. imgPath: 'widget://res/img/apicloud.png',
  47. subTitle: '子标题,说明文字',
  48. remark: '备注',
  49. icon: ''
  50. }, {
  51. uid: '1001',
  52. imgPath: 'widget://res/img/apicloud.png',
  53. title: '标题',
  54. subTitle: '子标题,说明文字',
  55. remark: '备注',
  56. icon: ''
  57. }, {
  58. uid: '1001',
  59. imgPath: 'widget://res/img/apicloud.png',
  60. title: '标题',
  61. subTitle: '子标题,说明文字',
  62. remark: '备注',
  63. icon: ''
  64. }, {
  65. uid: '1001',
  66. imgPath: 'widget://res/img/apicloud.png',
  67. title: '标题',
  68. subTitle: '子标题,说明文字',
  69. remark: '备注',
  70. icon: ''
  71. }, {
  72. uid: '1001',
  73. imgPath: 'widget://res/img/apicloud.png',
  74. title: '标题',
  75. subTitle: '子标题,说明文字',
  76. remark: '备注',
  77. }, {
  78. imgPath: 'widget://res/img/apicloud.png',
  79. title: '标题',
  80. subTitle: '子标题,说明文字',
  81. remark: '备注',
  82. icon: ''
  83. }],
  84. rightBtns: [{
  85. bgColor: '#388e8e',
  86. activeBgColor: '',
  87. width: 70,
  88. title: '按钮',
  89. titleSize: 12,
  90. titleColor: '#fff',
  91. icon: '',
  92. iconWidth: 20
  93. }],
  94. styles: {
  95. borderColor: '#696969',
  96. item: {
  97. bgColor: '#AFEEEE',
  98. activeBgColor: '#F5F5F5',
  99. height: 55.0,
  100. imgWidth: 40,
  101. imgHeight: 40,
  102. imgCorner: 4,
  103. placeholderImg: '',
  104. titleSize: 12.0,
  105. titleColor: '#000',
  106. subTitleSize: 12.0,
  107. subTitleColor: '#000',
  108. remarkColor: '#000',
  109. remarkSize: 16,
  110. remarkIconWidth: 30
  111. }
  112. },
  113. fixedOn: api.frameName
  114. }, function(ret, err) {
  115. if (ret) {
  116. alert(JSON.stringify(ret));
  117. } else {
  118. alert(JSON.stringify(err));
  119. }
  120. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭数据列表模块

close()

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.close();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

show

显示 UIListView 模块

show()

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.show();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hide

隐藏 UIListView 模块

hide()

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.hide();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setAttr

设置列表的纵坐标和高度

setAttr({params}, callback(ret))

params

y:

  • 类型:数字
  • 描述:(可选项)模块的纵坐标
  • 默认值:原 y 值

h:

  • 类型:数字
  • 描述:(可选项)模块的高度
  • 默认值:原 h 值

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.setAttr({
  3. y: 40,
  4. h: 200
  5. }, function(ret, err) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. } else {
  9. alert(JSON.stringify(err));
  10. }
  11. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getIndex

根据开发者自定义的唯一标识(open 接口的 data 参数中自定义的唯一标识)查找列表项对应的数据

getIndex({params}, callback(ret, err))

params

key:

  • 类型:字符串
  • 描述:调用 open 接口时,data 参数传入的开发者自定义的唯一标识的 key

value:

  • 类型:字符串
  • 描述:调用 open 接口时,data 参数传入的开发者自定义的唯一标识的 value

callback(ret)

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. index: 0, //数字类型;当前列表项的索引
  3. data: [] //数组类型;当前列表项的数据,内部字段与 open 时的 data 参数一致
  4. }

示例代码

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getDataByIndex

根据列表项的索引获取对应的数据

getDataByIndex({params}, callback(ret))

params

index:

  • 类型:数字
  • 描述:(可选项)列表项的索引
  • 默认值:0

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. data: [] //数组类型;当前列表项的数据,内部字段与 open 时的 data 参数一致
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.getDataByIndex({
  3. index: 0
  4. }, function(ret, err) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. } else {
  8. alert(JSON.stringify(err));
  9. }
  10. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setSwipeBtns

设置侧滑显示出来的按钮

setSwipeBtns({params}, callback(ret))

params

index:

  • 类型:数字
  • 描述:(可选项)列表项的索引
  • 默认值:0

btns:

  • 类型:数组
  • 描述:(可选项)列表项侧滑露出的按钮组
  • 内部字段:
  1. [{
  2. bgColor: '#388e8e', //(可选项)字符串类型;按钮背景色,支持 rgb、rgba、#;默认:'#388e8e'
  3. activeBgColor: '', //(可选项)字符串类型;按钮按下时的背景色,支持 rgb、rgba、#
  4. width: 70, //(可选项)数字类型;按钮的宽度;默认:w / 4
  5. title: '', //(可选项)字符串类型;按钮标题,水平、垂直居中
  6. titleSize: 12, //(可选项)数字类型;按钮标题文字大小;默认:12
  7. titleColor: '#fff', //(可选项)字符串类型;按钮标题文字颜色,支持 rgb、rgba、#;默认:'#ffffff'
  8. icon: '', //(可选项)字符串类型;按钮标题前的图标路径(本地路径,支持fs://、widget://),水平、垂直居中,图标为正方形
  9. iconWidth: 20 //(可选项)数字类型;按钮标题前的图标宽度,图标为正方形;默认:20
  10. }]

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.setSwipeBtns({
  3. index: 0,
  4. btns: [{
  5. bgColor: '#388e8e',
  6. activeBgColor: '',
  7. width: 70,
  8. title: '',
  9. titleSize: 12,
  10. titleColor: '#fff',
  11. icon: '',
  12. iconWidth: 20
  13. }]
  14. }, function(ret, err) {
  15. if (ret) {
  16. alert(JSON.stringify(ret));
  17. } else {
  18. alert(JSON.stringify(err));
  19. }
  20. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reloadData

刷新列表数据

reloadData({params}, callback(ret))

params

data:

  • 类型:数组
  • 描述:(可选项)列表的数据源,若不传或传空,仅收起下拉刷新组件
  • 内部字段:
  1. [{
  2. imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
  3. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  4. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  5. remark: '', //(可选项)字符串类型;右边备注文字
  6. icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
  7. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
  8. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同 rightBtns 参数
  9. }]

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.reloadData({
  3. data: [{
  4. imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
  5. title: '新标题',
  6. subTitle: '新子标题',
  7. remark: '新备注',
  8. icon: ''
  9. }]
  10. if (ret) {
  11. alert(JSON.stringify(ret));
  12. } else {
  13. alert(JSON.stringify(err));
  14. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

deleteItem

根据索引删除某一条列表的数据

deleteItem({params}, callback(ret))

params

index:

  • 类型:数字
  • 描述:(可选项)数据列表的索引
  • 默认值:0

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.deleteItem({
  3. index: 2
  4. }, function(ret, err) {
  5. if (ret) {
  6. alert(JSON.stringify(ret));
  7. } else {
  8. alert(JSON.stringify(err));
  9. }
  10. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

updateItem

根据索引更新某一条列表的数据

updateItem({params}, callback(ret))

params

index:

  • 类型:数字
  • 描述:(可选项)数据列表的索引
  • 默认值:0

data:

  • 类型:JSON 对象
  • 描述:列表的数据源
  • 内部字段:
  1. {
  2. imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
  3. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  4. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  5. remark: '', //(可选项)字符串类型;右边备注文字
  6. icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
  7. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
  8. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同 rightBtns 参数
  9. }

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.updateItem({
  3. index: 2,
  4. data: {
  5. imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
  6. title: '刷新标题',
  7. subTitle: '刷新子标题',
  8. remark: '刷新备注'
  9. }
  10. }, function(ret, err) {
  11. if (ret) {
  12. alert(JSON.stringify(ret));
  13. } else {
  14. alert(JSON.stringify(err));
  15. }
  16. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

insertItem

根据索引向某一条列表插入数据

insertItem({params}, callback(ret, err))

index:

  • 类型:数字
  • 描述:(可选项)数据列表的索引
  • 默认值:列表最后一条数据的索引

data:

  • 类型:JSON 对象
  • 描述:列表的数据源
  • 内部字段:
  1. {
  2. imgPath: '', //(可选项)字符串类型;列表项的附图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
  3. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  4. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  5. remark: '', //(可选项)字符串类型;右边备注文字
  6. icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
  7. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
  8. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,内部字段同 open 接口的 rightBtns 参数
  9. }

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.insertItem({
  3. index: 2,
  4. data: {
  5. imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
  6. title: '12:00',
  7. subTitle: 'APICloud粉丝互动会',
  8. remark: '完成'
  9. }
  10. }, function(ret, err) {
  11. if (ret) {
  12. alert(JSON.stringify(ret));
  13. } else {
  14. alert(JSON.stringify(err));
  15. }
  16. });

可用性

可提供的1.0.0及更高版本

appendData

向列表末端追加数据

appendData({params}, callback(ret))

params

data:

  • 类型:数组对象
  • 描述:列表的数据源,若不传或传空,仅收起上拉加载组件
  • 内部字段:
  1. [{
  2. imgPath: '', //(可选项)字符串类型;列表项的附图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,若不传则标题和子标题靠最左侧显示
  3. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  4. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  5. remark: '', //(可选项)字符串类型;右边备注文字
  6. icon: '', //(可选项)字符串类型;右侧备注的图标路径(本地路径,支持fs://、widget://)
  7. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 open->styles->forbidden参数配置
  8. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,内部字段同 open 接口的 rightBtns 参数
  9. }]

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. status: true //布尔型;true||false
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.appendData({
  3. data: [{
  4. imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
  5. title: '新增标题',
  6. subTitle: '新增子标题',
  7. remark: '新增备注'
  8. }]
  9. }, function(ret, err) {
  10. if (ret) {
  11. alert(JSON.stringify(ret));
  12. } else {
  13. alert(JSON.stringify(err));
  14. }
  15. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getCount

获取当前列表的总数据量

getCount(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. count: 21 //数字类型;当前列表包含的数据总数
  3. }

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.getCount(function(ret) {
  3. alert(JSON.stringify(ret));
  4. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setRefreshHeader

设置下拉刷新,通过 reloadData 收起下拉刷新组件

setRefreshHeader({params}, callback(ret))

params

loadingImg:

  • 类型:字符串
  • 描述:下拉刷新时显示的小箭头图标的本地路径,要求本地路径(fs://、widget://)

bgColor:

  • 类型:字符串
  • 描述:(可选项)下拉刷新区域的背景色,支持 rgb、rgba、#
  • 默认值:’#f5f5f5’

textColor:

  • 类型:字符串
  • 描述:(可选项)提示文字颜色,支持 rgb、rgba、#
  • 默认值:’#8e8e8e’

textDown:

  • 类型:字符串
  • 描述:(可选项)下拉提示文字
  • 默认值:下拉可以刷新…

textUp:

  • 类型:字符串
  • 描述:(可选项)松开提示文字
  • 默认值:松开开始刷新…

loadingText:

  • 类型:字符串
  • 描述:(可选项)提示文字
  • 默认值:正在加载…

lastUpdateText:

  • 类型:字符串
  • 描述:(可选项)提示文字
  • 默认值:上次更新时间:

showTime:

  • 类型:布尔值
  • 描述:(可选项)是否显示刷新时间
  • 默认值:true

callback()

下拉刷新的事件回调

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.setRefreshHeader({
  3. loadingImg: 'widget://res/UIListView_arrow.png',
  4. bgColor: '#F5F5F5',
  5. textColor: '#8E8E8E',
  6. textDown: '下拉可以刷新...',
  7. textUp: '松开开始刷新...',
  8. showTime: true
  9. }, function(ret, err) {
  10. if (ret) {
  11. alert(JSON.stringify(ret));
  12. } else {
  13. alert(JSON.stringify(err));
  14. }
  15. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setRefreshFooter

设置上拉加载,通过 appendData 收起上拉加载组件

setRefreshFooter({params}, callback())

params

loadingImg:

  • 类型:字符串
  • 描述:上拉加载时显示的小箭头图标的本地路径,要求本地路径(fs://、widget://)

bgColor:

  • 类型:字符串
  • 描述:(可选项)上拉加载区域的背景色,支持 rgb、rgba、#
  • 默认值:’#f5f5f5’

textColor:

  • 类型:字符串
  • 描述:(可选项)提示文字颜色,支持 rgb、rgba、#
  • 默认值:’#8e8e8e’

textUp:

  • 类型:字符串
  • 描述:(可选项)上拉提示文字
  • 默认值:’上拉加载更多…’

textDown:

  • 类型:字符串
  • 描述:(可选项)松开提示文字
  • 默认值:’松开开始加载…’

loadingText:

  • 类型:字符串
  • 描述:(可选项)提示文字
  • 默认值:正在加载…

lastUpdateText:

  • 类型:字符串
  • 描述:(可选项)提示文字
  • 默认值:上次更新时间:

showTime:

  • 类型:布尔值
  • 描述:(可选项)是否显示刷新时间
  • 默认值:true

callback(ret)

上拉加载的事件回调

示例代码

  1. var UIListView = api.require('UIListView');
  2. UIListView.setRefreshFooter({
  3. loadingImg: 'widget://res/UIListView_arrow.png',
  4. bgColor: '#F5F5F5',
  5. textColor: '#8E8E8E',
  6. textUp: '上拉加载更多...',
  7. textDown: '松开开始加载...',
  8. showTime: true
  9. }, function(ret, err) {
  10. if (ret) {
  11. alert(JSON.stringify(ret));
  12. } else {
  13. alert(JSON.stringify(err));

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

论坛示例

为帮助用户更好更快的使用模块,论坛维护了一个,示例中包含示例代码、知识点讲解、注意事项等,供您参考。