bui.hint Class

Defined in: src/scripts/ui/bui.hint.js:9

Module: UI

自动消失提示框

默认从底部弹出,4秒后消失,可以自行修改,也可以改成手动关闭的方式.

预览地址: demo

方法说明:

hide: 隐藏
show: 显示
isShow: 当前状态
remove: 移除
option: 获取设置参数
widget: 获取依赖控件

Constructor

`bui.hint`

(

[option]

)

Defined in src/scripts/ui/bui.hint.js:9

Parameters:

[option] Object optional
- [appendTo] String optional
  
  在某个容器内例如:#page
- [width] Number | String optional
  
  1.5.4新增, 宽度, 默认: 0, 支持百分比
- [height] Number optional
  
  1.5.4新增, 高度, 默认: 0, 高度不支持百分比
- [content] String optional
  
  提醒的内容,没有内容只是引用,不执行
- [skin] String optional
  
  1.5.0新增, 默认:"" | warning | primary | success | danger
- [effect] String optional
  
  动画效果,参考toggle
- [timeout] Number optional
  
  多少秒后消失单位:ms
- [autoTrigger] Boolean optional
  
  1.5.5新增, 是否自动触发显示默认true | false
- [autoClose] Boolean optional
  
  是否自动关闭默认true | false
- [showClose] Boolean optional
  
  是否显示关闭图标默认false | true
- [zIndex] Number optional
  
  默认130
- [position] String optional
  
  bottom | top
- [closeIcon] String optional
  
  关闭的图标默认： icon-close
- [onBeforeInit] Function optional
  
  1.5.1新增初始化前触发
- [onInited] Function optional
  
  1.5.1新增初始化以后触发
- [onClose] Function optional
  
  关闭的时候执行
- [onHided] Function optional
  
  1.6.2 新增关闭后执行

Example:

   方法1: 快速提醒
                                           bui.hint("确定会删除信息,不可还原");

方法2: 可以修改更多参数 bui.hint({ appendTo: "", content: "", timeout: 2000, autoClose: false, //不开启倒计时 position: "bottom", // bottom || top onClose: null }) 方法2: 居中提醒示例 bui.hint({ content:"
欢迎使用BUI", position:"center" , effect:"fadeInDown" });

Index
Methods
Events

Item Index

Events

Methods

`destroy`

(

[bool]

)

Defined in src/scripts/ui/bui.hint.js:478

[销毁控件]

Parameters:

[bool] Boolean optional

默认: false 销毁部分 | true 销毁全部

Example:

       //销毁
                                                       uiHint.destroy();

`hide`

(

text

)

chainable

Defined in src/scripts/ui/bui.hint.js:359

隐藏提醒

Parameters:

text String

提醒的文本

Example:

       var uiHint = bui.hint({ "content": "提醒的信息", "autoClose": true});
                                                
                                                           //如果一直存在,就需要手动关闭了
                                                           uiHint.hide();

`init`

(

[option]

)

chainable

Defined in src/scripts/ui/bui.hint.js:147

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

Parameters:

[option] Object optional

参数控件本身

`isShow`

() chainable

Defined in src/scripts/ui/bui.hint.js:317

当前的显示状态

Example:

       var uiHint = bui.hint("提醒的信息");
                                                           uiHint.isShow();

`option`

(

[key]
[value]

)

chainable

Defined in src/scripts/ui/bui.hint.js:518

获取设置参数

Parameters:

[key] String | object optional

不传则获取所有参数, 类型为string,没有第2个参数则获取某个参数
[value] String | number | boolean | function optional

设置参数的时候要传,设置多个参数不用传,获取参数的时候也不用传

Example:

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

`remove`

() chainable

Defined in src/scripts/ui/bui.hint.js:331

移除提醒

Example:

       var uiHint = bui.hint("提醒的信息");
                                                           uiHint.remove();

`show`

(

option

)

chainable

Defined in src/scripts/ui/bui.hint.js:399

显示提醒

Parameters:

option Function

回调

Example:

       var uiHint = bui.hint({ "content": "提醒的信息", "autoTrigger": false});
                                                
                                                           //示例1: 显示
                                                           uiHint.show();
                                                
                                                           //示例2:
                                                           uiHint.text("新提醒消息").show();
                                                
                                                           //示例3:
                                                           uiHint.text("新提醒消息").show(function(){
                                                               // 展示的时候做什么
                                                           });

`text`

(

val

)

chainable

Defined in src/scripts/ui/bui.hint.js:545

Available since 1.5.5

修改文本

Parameters:

val String

[修改的文本]

Example:

      //修改文本
                                                      uiHint.text("1321");

`widget`

(

[name]

)

Defined in src/scripts/ui/bui.hint.js:500

Available since 1.4.2

获取依赖的控件

Parameters:

[name] String optional

依赖控件名 toggle

Example:

       //获取依赖控件
                                                       var uiHintWidget = uiHint.widget();

Events

`off`

Defined in src/scripts/ui/bui.hint.js:582

Available since 1.3.0

为控件取消绑定事件

Event Payload:

[type] String optional

事件类型: "show" | "hide"(隐藏或者移除时)
[callback] Function optional

绑定的事件, this 为当前点击的菜单

Example:

       uiHint.off("show");

`on`

Defined in src/scripts/ui/bui.hint.js:562

Available since 1.3.0

为控件绑定事件

Event Payload:

[type] String optional

事件类型: "show" | "hide"(隐藏或者移除时)
[callback] Function optional

绑定的事件, this 为当前点击的菜单

Example:

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