UIListArrow

来自于:AC模块工作室立即使用

open close show hide setAttr getIndex getDataByIndex setSwipeBtns reloadData deleteItem updateItem insertItem appendData getCount setRefreshHeader setRefreshFooter

概述

UIListArrow 模块封装了一个数据列表控件,列表项水平侧滑可出现控制按钮;开发者可自定义列表的数据源,及列表的样式,支持列表项的增、删、改、查,支持批量更新、追加数据,支持下拉刷新和上拉加载事件。 本模块是基于 APICloud 开源模块 UIListView 修改的。

UIListArrow - 图1

open

打开 UIListArrow 模块

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

params

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 注意:在 Android 平台上此参数必须传
  • 内部字段:
  1. {
  2. x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
  3. y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
  4. w: 320, //(可选项)数字类型;模块的宽度,支持设置'auto';默认值:所属的 Window 或 Frame 的宽度
  5. h: 480 //(可选项)数字类型;模块的高度,支持设置'auto';默认值:所属的 Window 或 Frame 的高度
  6. }

data:

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

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
  • 默认:false

styles:

  • 类型:JSON 对象
  • 描述:(可选项)模块各部分的样式
  • 内部字段:
  1. {
  2. badge:{
  3. color:'#f00', //(可选项)字符串类型;徽章的背景颜色,支持 rgb、rgba、#;默认:'#696969'
  4. size: 6.0, //(可选项)数字类型;徽章半径大小;默认值:6.0(仅支持iOS)
  5. titleSize:8 , //(可选项)数字类型;徽章文字大小;默认:12(仅支持iOS)
  6. titleColor:'#fff' //(可选项)数字类型;徽章文字颜色;默认:'#fff'
  7. },
  8. borderColor: '#696969', //(可选项)字符串类型;列表分割线的颜色,支持 rgb、rgba、#;默认:'#696969'
  9. item: { //(可选项)JSON对象;列表项的样式
  10. bgColor: '#AFEEEE', //(可选项)字符串类型;列表项的背景色,支持 rgb、rgba、#;默认:'#AFEEEE'
  11. activeBgColor: '#F5F5F5', //(可选项)字符串类型;列表项按下时的背景色,支持 rgb、rgba、#;默认:'#F5F5F5'
  12. height: 55, //(可选项)数字类型;列表项的高度;默认:55
  13. imgMarginLeft:10, //(可选项)数字类型;列表项的图片的左边距;默认:10
  14. imgMarginRight:10, //(可选项)数字类型;列表项的图片的右边距;默认:10
  15. imgWidth: 20, //(可选项)数字类型;列表项配图的宽度;默认:列表项的高度减去10px
  16. imgHeight: 20, //(可选项)数字类型;列表项配图的高度;默认:列表项的高度减去10px
  17. placeholderImg: '', //(可选项)字符串类型;列表项配图的占位图路径(本地路径,fs://、widget://),默认:APICloud 图标
  18. titleMarginTop:5 //(可选项)数字类型;列表项的图片的上边距;默认:5(跟time的上边距相同)
  19. subTitleMarginBottom:5 //(可选项)数字类型;列表项的图片的下边距;默认:5
  20. titleSize: 12, //(可选项)数字类型;列表项标题文字大小;默认:12
  21. titleColor: '#000', //(可选项)字符串类型;列表项标题文字颜色,支持 rgb,rgba,#;默认:'#000000'
  22. subTitleSize: 12, //(可选项)数字类型;列表项子标题文字大小;默认:12
  23. subTitleColor: '#000', //(可选项)字符串类型:列表项子标题文字颜色,支持 rgb、rgba、#;默认:'#000000'
  24. subTitleWidth: 100 //(可选项)数字类型;列表项子标题文字的宽度;默认:100
  25. timeColor: '#000', //(可选项)字符串类型;时间标签的文字颜色,支持 rgb、rgba、#;默认:'#000000'
  26. timeSize: 16, //(可选项)数字类型;时间标签的文字大小;默认:16
  27. timeMarginTop:10, //(可选项)数字类型;时间标签的上边距;默认:10
  28. arrowMarginLeft:10 //(可选项)数字类型;箭头的左边距;默认:10
  29. arrowMarginBottom:10, //(可选项)数字类型;箭头的下边距;默认:10
  30. arrowImg:'', //(可选项)字符串类型;列表项右边箭头显示的内容
  31. arrowSize:10 //(可选项)数字类型;箭头的大小;默认:10
  32. marginRight: 10 //(可选项)数字类型;时间标签和徽章(badge)距离模块右边距;默认:10
  33. }
  34. }

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. index: 0, //数字类型;列表项的索引
  9. btnIndex: 0 //数字类型;列表项侧滑出现的按钮的索引
  10. }

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.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. time: '今天 13:45',
  15. badge: 1,
  16. imgCorner: 4
  17. }, {
  18. uid: '1001',
  19. imgPath: 'widget://res/img/apicloud.png',
  20. title: '标题',
  21. subTitle: '子标题,说明文字',
  22. time: '今天 13:45',
  23. badge: 1
  24. }, {
  25. uid: '1001',
  26. imgPath: 'widget://res/img/apicloud.png',
  27. title: '标题',
  28. subTitle: '子标题,说明文字',
  29. time: '今天 13:45',
  30. badge: 1
  31. }, {
  32. uid: '1001',
  33. imgPath: 'widget://res/img/apicloud.png',
  34. title: '标题',
  35. subTitle: '子标题,说明文字',
  36. time: '今天 13:45',
  37. badge: 1
  38. }, {
  39. uid: '1001',
  40. imgPath: 'widget://res/img/apicloud.png',
  41. title: '标题',
  42. subTitle: '子标题,说明文字',
  43. time: '今天 13:45',
  44. badge: 1
  45. }, {
  46. uid: '1001',
  47. imgPath: 'widget://res/img/apicloud.png',
  48. title: '标题',
  49. subTitle: '子标题,说明文字',
  50. time: '今天 13:45',
  51. badge: 1
  52. }, {
  53. uid: '1001',
  54. imgPath: 'widget://res/img/apicloud.png',
  55. title: '标题',
  56. subTitle: '子标题,说明文字',
  57. time: '今天 13:45',
  58. badge: 1
  59. }, {
  60. uid: '1001',
  61. imgPath: 'widget://res/img/apicloud.png',
  62. title: '标题',
  63. subTitle: '子标题,说明文字',
  64. time: '今天 13:45',
  65. badge: 1
  66. }, {
  67. uid: '1001',
  68. imgPath: 'widget://res/img/apicloud.png',
  69. title: '标题',
  70. subTitle: '子标题,说明文字',
  71. time: '今天 13:45',
  72. badge: 1
  73. }, {
  74. uid: '1001',
  75. imgPath: 'widget://res/img/apicloud.png',
  76. title: '标题',
  77. subTitle: '子标题,说明文字',
  78. time: '今天 13:45',
  79. badge: 1
  80. }, {
  81. imgPath: 'widget://res/img/apicloud.png',
  82. title: '标题',
  83. subTitle: '子标题,说明文字',
  84. time: '今天 13:45',
  85. badge: 1
  86. }],
  87. rightBtns: [{
  88. bgColor: '#388e8e',
  89. activeBgColor: '',
  90. width: 70,
  91. title: '按钮',
  92. titleSize: 12,
  93. titleColor: '#fff',
  94. time: '今天 13:45',
  95. badge: '1'
  96. }],
  97. styles: {
  98. header:{
  99. bg:'#fff' ,
  100. height:20,
  101. },
  102. footer:{
  103. bg:'#fff' ,
  104. height:20,
  105. },
  106. badge:{
  107. color:'#f00',
  108. titleColor:'#fff'
  109. },
  110. borderColor: '#696969',
  111. item: {
  112. bgColor: '#AFEEEE',
  113. activeBgColor: '#F5F5F5',
  114. height: 55,
  115. imgMarginLeft:10,
  116. imgMarginRight:10,
  117. imgWidth: 20,
  118. imgHeight: 20,
  119. placeholderImg: '',
  120. titleMarginTop:5,
  121. subTitleMarginBottom:5,
  122. titleSize: 12,
  123. titleColor: '#000',
  124. subTitleSize: 12,
  125. subTitleColor: '#000',
  126. subTitleWidth: 100,
  127. timeColor: '#000',
  128. timeSize: 16,
  129. marginRight: 10,
  130. }
  131. },
  132. fixedOn: api.frameName
  133. }, function(ret, err) {
  134. if (ret) {
  135. alert(JSON.stringify(ret));
  136. } else {
  137. alert(JSON.stringify(err));
  138. }
  139. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭数据列表模块

close()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

show

显示 UIListBadge 模块

show()

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hide

隐藏 UIListBadge 模块

hide()

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.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 UIListArrow = api.require('UIListArrow');
  2. UIListArrow.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)

ret:

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

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.getIndex({
  3. key: 'uid',
  4. value: '1001'
  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及更高版本

getDataByIndex

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

getDataByIndex({params}, callback(ret))

params

index:

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

callback(ret)

ret:

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

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.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 UIListArrow = api.require('UIListArrow');
  2. UIListArrow.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://等协议,网络图片会被缓存到本地,默认显示apicloud图片
  3. imgCorner: 4, //(可选项)数字类型;列表项配图的圆角大小;默认:0
  4. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  5. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  6. time: '', //(可选项)字符串类型;时间标签,若不传则不显示,若不传或为空则 badge和arrowImg 上下位置居中显示
  7. badge: , //(可选项)数字类型;右下角徽章显示的内容,若不传则不显示
  8. arrowImg:'', //(可选项)字符串类型;列表项右边箭头显示的内容
  9. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 styles->forbidden参数配置
  10. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同下方 rightBtns 参数
  11. }]

callback(ret)

ret:

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

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.reloadData({
  3. data: [{
  4. imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
  5. title: '新标题',
  6. subTitle: '新子标题',
  7. }]
  8. }, function(ret) {
  9. if (ret) {
  10. alert(JSON.stringify(ret));
  11. } else {
  12. alert(JSON.stringify(err));
  13. }
  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 UIListArrow = api.require('UIListArrow');
  2. UIListArrow.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://等协议,网络图片会被缓存到本地,默认显示apicloud图片
  3. imgCorner: 4, //(可选项)数字类型;列表项配图的圆角大小;默认:0
  4. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  5. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  6. time: '', //(可选项)字符串类型;时间标签,若不传则不显示,若不传或为空则 badge和arrowImg 上下位置居中显示
  7. badge: , //(可选项)数字类型;右下角徽章显示的内容,若不传则不显示
  8. arrowImg:'', //(可选项)字符串类型;列表项右边箭头显示的内容
  9. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 styles->forbidden参数配置
  10. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同下方 rightBtns 参数
  11. }

callback(ret)

ret:

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

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.updateItem({
  3. index: 2,
  4. data: {
  5. imgPath: 'http://img1.3lian.com/gif/more/11/201206/a5194ba8c27b17def4a7c5495aba5e32.jpg',
  6. title: '刷新标题',
  7. subTitle: '刷新子标题',
  8. badge: '2'
  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))

params

index:

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

data:

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

callback(ret)

ret:

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

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.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. badge: '10'
  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及更高版本

appendData

向列表末端追加数据

appendData({params}, callback(ret))

params

data:

  • 类型:数组对象
  • 描述:列表的数据源,若不传或传空,仅收起上拉加载组件
  • 内部字段:
  1. [{
  2. imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地,默认显示apicloud图片
  3. imgCorner: 4, //(可选项)数字类型;列表项配图的圆角大小;默认:0
  4. title: '', //(可选项)字符串类型;标题,若不传或为空则 subTitle 上下位置居中显示
  5. subTitle: '', //(可选项)字符串类型;子标题,若不传或为空则 title 上下位置居中显示
  6. time: '', //(可选项)字符串类型;时间标签,若不传则不显示,若不传或为空则 badge和arrowImg 上下位置居中显示
  7. badge: , //(可选项)数字类型;右下角徽章显示的内容,若不传则不显示
  8. arrowImg:'', //(可选项)字符串类型;列表项右边箭头显示的内容
  9. forbidden: false, //(可选项)布尔类型;是否屏蔽本条数据的点击事件,屏蔽后的样式可通过 styles->forbidden参数配置
  10. rightBtns: [] //(可选项)数组类型;列表项向左滑动露出的按钮组,配置某一项的特定按钮组,若不传则显示通用按钮,内部字段同下方 rightBtns 参数
  11. }]

callback(ret)

ret:

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

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.appendData({
  3. data: [{
  4. imgPath: 'http://d.hiphotos.baidu.com/image/pic/item/4d086e061d950a7b29a788c209d162d9f2d3c922.jpg',
  5. title: '新增标题',
  6. subTitle: '新增子标题',
  7. badge: '3'
  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 UIListArrow = api.require('UIListArrow');
  2. UIListArrow.getCount(function(ret) {
  3. alert(JSON.stringify(ret));
  4. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

setRefreshHeader

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

setRefreshHeader({params}, callback(ret))

params

style:

  • 类型:JSON对象
  • 描述:下拉刷新的样式配置
  • 内部字段:
  1. {
  2. bgColor: '#C0C0C0', //(可选项)字符串类型;下拉刷新的背景设置,支持 rgb、rgba、#,该背景大小同当前模块的宽高;默认:#C0C0C0
  3. refreshHeaderHeight : 60 , //(可选项)数字类型;下拉高度达到一定阈值,本参数暂仅支持 ios 平台;默认:60
  4. loadAnimInterval : 200 , //(可选项)数字类型;图片播放时间间隔,单位为毫秒;默认:200
  5. image: { //(可选项)JSON 对象类型;下拉刷新相关图片设置;若不传则使用默认图标
  6. pull:['fs://t1.png','fs://t2.png',...], //(可选项)数组类型;组成下拉过程的动画关键帧图片数组,这组图片随下拉高度同步放大缩小,同时自动播放关键帧图片:每下拉一定距离(阈值/图片数量),播放一帧关键帧图片;图片规格为正方形,如:50*50、100*100;若不传则使用默认图标
  7. load: ['fs://t1.png','fs://t2.png',...] //(可选项)数组类型;组成下拉刷新加载状态动画的关键帧图片数组,图片为正方形的,如:50*50、100*100,建议开发者传大小合适的图片以适配高分辨率手机屏幕;若不传则使用默认图标
  8. },
  9. isScale: true //(可选项)布尔类型;播放下拉过程中的关键帧动画时,是否同时添加等比同步缩放效果;默认值:true
  10. }

callback()

下拉刷新的事件回调

示例代码

  1. var UIListArrow = api.require('UIListArrow');
  2. UIListArrow.setRefreshHeader({
  3. style: {
  4. bgColor: '#C0C0C0',
  5. isScale: true,
  6. image: {
  7. pull: [
  8. 'widget://image/refresh/dropdown0.png',
  9. 'widget://image/refresh/dropdown1.png',
  10. 'widget://image/refresh/dropdown2.png',
  11. 'widget://image/refresh/dropdown3.png',
  12. 'widget://image/refresh/dropdown4.png',
  13. 'widget://image/refresh/dropdown5.png',
  14. 'widget://image/refresh/dropdown6.png'
  15. ],
  16. load: [
  17. 'widget://image/refresh/loading0.png',
  18. 'widget://image/refresh/loading1.png',
  19. 'widget://image/refresh/loading2.png',
  20. 'widget://image/refresh/loading3.png',
  21. 'widget://image/refresh/loading4.png'
  22. ]
  23. }
  24. }
  25. }, function(ret) {
  26. //下拉刷新被触发,自动进入加载状态,使用 reloadData() 手动结束加载中状态
  27. alert('开始加载刷新数据,摇一摇停止加载状态');
  28. api.addEventListener({
  29. name: 'shake'
  30. }, function(ret, err) {
  31. UIListBadge.reloadData();
  32. });
  33. });

可用性

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 UIListArrow = api.require('UIListArrow');
  2. UIListArrow.setRefreshFooter({
  3. loadingImg: 'widget://res/UIListBadge_arrow.png',
  4. bgColor: '#F5F5F5',
  5. textColor: '#8E8E8E',
  6. textUp: '上拉加载更多...',
  7. textDown: '松开开始加载...',
  8. showTime: true
  9. }, function(ret) {
  10. //上拉加载事件被触发,自动进入加载状态,使用 appendData() 手动结束加载中状态
  11. alert('开始加载刷新数据,摇一摇停止加载状态');
  12. api.addEventListener({
  13. name: 'shake'
  14. }, function(ret, err) {
  15. UIListBadge.appendData();
  16. });
  17. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本