UIListContactsCheck

close show

概述

UIListContactsCheck 展示了一个联系人列表。开发者只需传入数据源,模块会自动将联系人排序,展示出来。列表右侧字母导航条会自动随联系人数量调整。

列表条目(cell)布局如下图所示:

open

打开列表

open({params}, callback(ret))

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 内部字段:

contacts:

  • 类型:数组对象
  • 描述:列表数据源
  • 内部字段:
  1. imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地 ,不传则不显示
  2. title: '艾雪瑞', //字符串类型;条目的标题, 若subTitle不传或为空则title居中显示
  3. subTitle: '创达集团', //字符串类型;条目的子标题, 若title不传或为空则subTitle居中显示
  4. phonetic:'', //(可选项)字符串类型; title汉字拼音
  5. position: '员工', //字符串类型;条目的职位,不传则不显示
  6. checkBoxSelected:false, //(可选项) 布尔类型;复选框是否选中;默认:false
  7. supportChecked:true //(可选项) 布尔类型;是否允许选中;默认:true
  8. cancelable:true , //(可选项) 布尔类型;已经选中的是否能被取消;默认:true
  9. disabled: true //(可选项) 布尔类型;是否禁用;默认:false
  10. }]

styles:

  • 类型:JSON 对象
  • 描述:(可选项)模块头部的样式
  • 内部字段:
  1. {
  2. alphabetColor:'#000', //(可选项)字符串类型;字母索引的颜色,支持rgb、rgba、#;默认:'#000'
  3. alphabetSelected:'#000', //(可选项)字符串类型;字母索引的选中色,支持rgb、rgba、#;默认:'#e1e1e1'
  4. alphabetBg:'"#e1e1e1', //(可选项)字符串类型;字母索引的背景颜色,支持rgb、rgba、#;默认:'"#e1e1e1'
  5. indexer:{ //(可选项)设置索引条的上下边距(该参数仅支持android)
  6. marginTop: 100, //(可选项)数字类型;索引上边距;默认:0
  7. marginBottom:100 //(可选项)数字类型;索引下边距;默认:0
  8. },
  9. item: { //(可选项)JSON对象;列表项的样式
  10. dividingLine:{ //(可选项)JSON对象;分割线样式
  11. leftMargin:10, //(可选项)数字类型;分割线的宽度,默认:和文字的左边对齐
  12. lineHeight:0.5, //(可选项)数字类型;分割线的高度,默认:0.5
  13. lineColor:'#e4e4e4', //(可选项)字符串类型;分割线的颜色,默认:'#e4e4e4'
  14. },
  15. checkBoxBtn:{ //(可选项)JSON对象;复选框样式,若不传则不显示
  16. marginLeft:10, //(可选项)数字类型;复选框的左边距,默认:10
  17. size:30, //(可选项)数字类型;复选框的大小,默认:30
  18. normalImg:'' //(可选项)字符串类型;未选中图标路径(本地路径,支持fs://、widget://)
  19. },
  20. position:{ //(可选项)JSON对象;条目的职位
  21. marginLeft:10, //(可选项)数字类型;职位的左边距,默认:10
  22. positionBg:'#f00', //(可选项)字符串类型;职位的背景颜色,默认:10
  23. positionCorner: 5 , //(可选项)数字类型;职位的圆角大小,默认:10
  24. positionWidth: 30 , //(可选项)数字类型;职位的宽,默认:30
  25. positionHeight: 20 , //(可选项)数字类型;职位的高,默认:20
  26. titleSize: 12, //(可选项)数字类型;列表项职位文字大小;默认:12
  27. titleColor: '#000', //(可选项)字符串类型;列表项职位文字颜色,支持 rgb,rgba,#;默认:'#000000'
  28. },
  29. bgColor: '#AFEEEE', //(可选项)字符串类型;列表项的背景色,支持 rgb、rgba、#;默认:'#AFEEEE'
  30. activeBgColor: '#F5F5F5', //(可选项)字符串类型;列表项按下时的背景色,支持 rgb、rgba、#;默认:'#F5F5F5'
  31. height: 55, //(可选项)数字类型;列表项的高度;默认:55
  32. imgMarginLeft:10, //(可选项)数字类型;列表项的图片的左边距;默认:10
  33. imgMarginRight:10, //(可选项)数字类型;列表项的图片的右边距;默认:10
  34. imgWidth: 40, //(可选项)数字类型;列表项配图的宽度;默认:列表项的高度减去10px
  35. imgHeight: 40, //(可选项)数字类型;列表项配图的高度;默认:列表项的高度减去10px
  36. imgCorner: 20, //(可选项)数字类型;列表项配图的圆角大小;默认:20
  37. titleMarginTop:5 //(可选项)数字类型;列表项的标题的上边距;默认:5
  38. titleSize: 12, //(可选项)数字类型;列表项标题文字大小;默认:12
  39. titleColor: '#000', //(可选项)字符串类型;列表项标题文字颜色,支持 rgb,rgba,#;默认:'#000000'
  40. titleWidth: 100 //(可选项)数字类型;列表项标题文字的宽度;默认:100
  41. subTitleMarginBottom:5 //(可选项)数字类型;列表项的子标题的下边距;默认:5
  42. subTitleSize: 12, //(可选项)数字类型;列表项子标题文字大小;默认:12
  43. subTitleColor: '#000', //(可选项)字符串类型:列表项子标题文字颜色,支持 rgb、rgba、#;默认:'#000000'
  44. subTitleWidth: 100, //(可选项)数字类型;列表项子标题文字的宽度;默认:100
  45. }
  46. }

backgroundColor:

  • 描述:(可选项)模块背景色
  • 默认:’#fff’
  • 类型:布尔
  • 描述:(可选项)是否弹动
  • 默认:false

fixedOn:

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

callback(ret)

ret:

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

示例代码

  1. UIListContactsCheck.open({
  2. rect : {
  3. x : 0,
  4. y : 44,
  5. w : api.frameWidth,
  6. h : api.frameHeight - 104
  7. },
  8. contacts : [{
  9. imgPath: '',
  10. title: '艾雪瑞',
  11. subTitle: '创达集团',
  12. }, {
  13. imgPath: '',
  14. title: '艾雪瑞',
  15. subTitle: '创达集团',
  16. }],
  17. fixedOn : api.frameName,
  18. bounces:true
  19. }, function(ret) {
  20. if (ret) {
  21. alert(JSON.stringify(ret));
  22. }
  23. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭列表模块

close()

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hide

隐藏列表模块,并没有从内存里清除

hide()

示例代码

可用性

可提供的1.0.0及更高版本

show

显示已隐藏的列表模块

show()

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

reloadData

刷新列表数据

reloadData({params})

params

contacts:

  • 类型:JSON 对象
  • 描述:列表数据源
  • 内部字段:
  1. [{
  2. imgPath: '', //(可选项)字符串类型;列表项的配图路径,支持http://、https://、widget://、fs://等协议,网络图片会被缓存到本地
  3. title: '艾雪瑞', //字符串类型;条目的标题,不传则不显示

示例代码

iOS系统,Android系统

可提供的1.0.0及更高版本