UIActionProgress

open close show

论坛示例

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

概述

UIActionProgress 是一个进度条模块,调用open 接口从底部弹出一个进度条展示区域,开发者可自定义该区域的标题、提示信息、进度及其样式。详细功能参考接口列表。

open

弹出进度条展示区域

open({params}, callback(ret))

maskBg:

  • 类型:字符串
  • 描述:(可选项)遮罩层配置,若不传则无遮罩层;支持rgb、rgba、#,如rgba(0,0,0,0.4)

styles:

  • 类型:JSON 对象
  • 描述:(可选项)弹出进度条样式配置
  • 内部字段:

data:

  • 类型:JSON 对象
  • 描述:进度条区域的数据配置
  • 内部字段:
  1. title: '正在更新...', //字符串类型;标题内容,仅当模块有标题区域时有效
  2. msg: '', //字符串类型;提示文字内容,仅当模块有提示区域时有效
  3. value: 1 //数字类型;进度条的值,取值范围:0-100
  4. }

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. eventType: 'show', //字符串类型;交互事件类型
  3. //取值范围:
  4. //show(打开模块成功)
  5. //click(点击遮罩层事件,仅当 maskBg 有值时有效)
  6. //complete(value值到100%时的事件)

示例代码

可用性

iOS系统,Android系统

setData

设置数据

setData({params})

params

data:

  • 类型:JSON 对象
  • 内部字段:
  1. {
  2. title: '正在更新...', //字符串类型;标题内容
  3. msg: '', //字符串类型;提示文字内容
  4. value: 1 //数字类型;进度条的值,取值范围:0-100
  5. }
  1. var UIActionProgress = api.require('UIActionProgress');
  2. UIActionProgress.setData({
  3. data: {
  4. title: '正在更新...',
  5. msg: '说明文字文字',
  6. }
  7. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

close

关闭模块

close()

示例代码

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hide

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

hide()

示例代码

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

可提供的1.0.0及更高版本

show

显示已隐藏的模块

show({params})

示例代码

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

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

getValue

获取当前进度条的值

getValue(callback(ret))

callback(ret)

ret:

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

示例代码

  1. var UIActionProgress = api.require('UIActionProgress');
  2. UIActionProgress.getValue(function(ret){
  3. alert(ret.value);
  4. });

iOS系统,Android系统

可提供的1.0.0及更高版本

论坛示例

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