BUI

其它版本:

API for BUI 1.6.x

Show:

bui.loading Class

Module: UI

进度条

有appendTo的时候是在id下的操作,没有的是在body下的,可以控制是否显示文本,或者自动关闭,甚至你还可以自定义你的进度条模板

预览地址: demo

方法说明:

show: 显示加载,如果存在则显示,如果不存在则创建
hide: 隐藏加载,如果存在则隐藏,不存在则没有操作
pause: 暂停滚动
text: 修改文本
showRing: 显示圈圈
hideRing: 隐藏圈圈
start: 显示加载,重新创建
stop: 移除加载
option: 获取设置参数
widget: 获取依赖控件
控件预览

Constructor

bui.loading

(
  • [option]
)

Parameters:

  • [option] Object optional
    • appendTo String

      [ appendTo是进度条生成的位置ID,默认在body标签下 ]

    • width Number

      [ 宽度 ]

    • height Number

      [ 高度 ]

    • text String

      [ 加载的文本 ]

    • autoTrigger Boolean

      [ 是否自动触发 默认 true | false ]

    • onlyText Boolean

      [ 是否只显示文本 ]

    • autoClose Boolean

      [ 默认true | false 是否点击自动关闭 ]

    • display String

      [ inline ]

    • [timeout] [ since1.3.0 是否开启定时关闭 默认0,大于零则开启定时关闭] String optional
    • [zIndex] [ since1.3.0 默认""的时候为130] String optional
    • [onBeforeInit] [ 1.5.1新增 初始化前触发] Function optional
    • [onInited] [ 1.5.1新增 初始化以后触发] Function optional
    • callback Function

      [ 回调 ]

Example:

 // 效果1:
                                       var uiLoading = bui.loading();
                                       //开启进度条
                                       //uiLoading.show();
                                       //关闭进度条
                                       //uiLoading.hide();
                                
                                       // 效果2:
                                       var uiLoading = bui.loading({
                                           appendTo:"#loading",
                                           display: "block",
                                           width: 30,
                                           height: 30,
                                           opacity: 0,
                                           callback: function (argument) {
                                               console.log("clickloading")
                                           }
                                       });
                                

Methods

destroy

(
  • [bool] [ 默认: false 销毁部分 | true 销毁全部]
)

Defined in src/scripts/ui/bui.loading.js:522

Available since 1.4.2

[销毁控件]

Parameters:

  • [bool] [ 默认: false 销毁部分 | true 销毁全部] Boolean optional

Example:

       //销毁
                                                   uiLoading.destroy();
                                            

hide

() chainable

隐藏loading

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.hide();
                                            

hideRing

() chainable

隐藏圈圈

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.hideRing();
                                            

init

(
  • [option] [参数控件本身]
)
chainable

初始化方法,用于重新初始化结构,事件只初始化一次

Parameters:

  • [option] [参数控件本身] Object optional

isLoading

() chainable

Defined in src/scripts/ui/bui.loading.js:358

Available since 1.5.1

是否正在展示

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.isLoading();
                                            

option

(
  • [key] [ 不传则获取所有参数, 类型为string,没有第2个参数则获取某个参数]
  • [value] [ 设置参数的时候要传,设置多个参数不用传,获取参数的时候也不用传]
)
chainable

获取设置参数

Parameters:

  • [key] [ 不传则获取所有参数, 类型为string,没有第2个参数则获取某个参数] String | object optional
  • [value] [ 设置参数的时候要传,设置多个参数不用传,获取参数的时候也不用传] String | number | boolean | function optional

Example:

       //获取所有参数
                                                    //获取所有参数
                                                   var option = uiLoading.option();
                                            
                                                   //获取某个参数
                                                   var id = uiLoading.option( "appendTo" );
                                            
                                                   //修改一个参数
                                                   uiLoading.option( "autoClose",true );
                                            
                                                   //修改多个参数
                                                   uiLoading.option( {"autoClose":true} );
                                            

pause

() chainable

Defined in src/scripts/ui/bui.loading.js:404

Available since 1.3.0

暂停loading

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.pause();
                                            

show

() chainable

显示loading

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.show();
                                            

showRing

() chainable

显示圈圈

Example:

           uiLoading.showRing();
                                            

start

() chainable

显示loading , 参数参考loading的初始化, 每次都重新创建

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.start();
                                            

stop

() chainable

关闭并移除loading

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.stop();
                                            

text

() chainable

修改文本

Example:

       var uiLoading = bui.loading();
                                                       uiLoading.text("正在加载");
                                            

widget

(
  • [name] [ 依赖控件名 mask]
)

获取依赖的控件

Parameters:

  • [name] [ 依赖控件名 mask] String optional

Example:

       //获取依赖控件
                                                   var uiLoadingWidget = uiLoading.widget();
                                            

Events

off

Defined in src/scripts/ui/bui.loading.js:617

Available since 1.3.0

为控件取消绑定事件

Event Payload:

  • [type] [ 事件类型: "show" | "hide" | "pause" (暂停转圈)| "start" (开始转圈) | "remove" (删除时)] String optional
  • [callback] [ 绑定的事件, this 为当前点击的菜单] Function optional

Example:

       uiLoading.off("show");
                                            

on

Defined in src/scripts/ui/bui.loading.js:597

Available since 1.3.0

为控件绑定事件

Event Payload:

  • [type] [ 事件类型: "show" | "hide" | "pause" (暂停转圈)| "start" (开始转圈) | "remove" (删除时)] String optional
  • [callback] [ 绑定的事件, this 为当前点击的菜单] Function optional

Example:

       uiLoading.on("show",function () {
                                                       // 点击的菜单
                                                       console.log(this);
                                                   });