BUI

其它版本:

API for BUI 1.6.x

Show:

bui.stepbar Class

Module: UI

步骤条 beta

demo
value: 设置第几步,跟获取当前在第几步
prev: 上一步
next: 下一步
option: 获取设置参数
widget: 获取依赖控件

Constructor

bui.stepbar

(
  • option
)

Parameters:

  • option Object
    • id String

      [控件id]

    • data Array

      [ 步骤的内容 例如:[{ title:"",subtitle:"",content:""}] ]

      • title String
        [ 步骤的标题 ]
      • [subtitle] [ 步骤的子标题] String optional
      • [className] [ 1.5.4新增 步骤的自定义样式名,例如:"step01"] String optional
      • [content] [ 步骤的内容] String optional
    • [template] [ 1.5.2新增, 默认null, 模板不满意,可以通过此方法返回新的模板,第一个参数为data的数据] Function optional
    • [hasNumber] [1.5.0新增, 默认false(原点中间无数字)|true(原点中间有数字)] Boolean optional
    • [lineCenter] [1.5.0新增, 默认false(圆点在线两端)|true(圆点在线中心)] Boolean optional
    • [handle] [点击的区域,属于循环的那部分] String optional
    • [click] [允许点击时候修改对应的激活状态] Boolean optional
    • [value] [1.5.6新增, 初始化在第几步] Number optional
    • [callback] [ 点击按钮的回调] Function optional
    • [onBeforeInit] [ 1.5.1新增 初始化前触发] Function optional
    • [onInited] [ 1.5.1新增 初始化以后触发] Function optional

Example:

html:

       <div id="step" class="bui-stepbar"></div>
                                

js:

       //初始化控件
                                       var uiStepbar = bui.stepbar({
                                           id: "#step",
                                           data: [{
                                               title: "预立项申请",
                                               subtitle: "2016-04-2 10:30",
                                               content: "成功创建申请,已经提交至XX部门经理审批,请耐心等待"
                                           },{
                                               title: "立项审批",
                                               subtitle: "2016-04-21 10:30",
                                               content: "审批完成,资料递交中"
                                           }]
                                       });
                                
                                       //激活第2步
                                       uiStepbar.value(1);
                                
                                   
                                   //2. 自定义模板初始化
                                   var uiStepbar = bui.stepbar({
                                       id: "#step",
                                       data: [{
                                           title: "预立项申请",
                                           subtitle: "2016-04-2 10:30",
                                           content: "成功创建申请,已经提交至XX部门经理审批,请耐心等待"
                                       },{
                                           title: "立项审批",
                                           subtitle: "2016-04-21 10:30",
                                           content: "审批完成,资料递交中"
                                       }],
                                       template: function(data) {
                                           var html = '';
                                           data && data.forEach(function(item,i) {
                                               html += `<div class="bui-stepbar-cell">
                                                           <span class="bui-stepbar-dot"></span>
                                                           <div class="bui-stepbar-text">
                                                               <h3>${item.title}</h3>
                                                               <p class="bui-stepbar-time">${item.subtitle}</p>
                                                               <p class="bui-stepbar-desc">${item.content}</p>
                                                           </div>
                                                       </div>`
                                           })
                                           return html;
                                       }
                                   });
                                

Item Index

Events

Methods

destroy

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

Defined in src/scripts/ui/bui.stepbar.js:322

Available since 1.4.2

[销毁控件]

Parameters:

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

Example:

       //销毁
                                                   uiStepbar.destroy();
                                            

init

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

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

Parameters:

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

next

()

下一步

Example:

       //下一步
                                                   uiStepbar.next();
                                            

option

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

获取设置参数

Parameters:

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

Example:

       //获取所有参数
                                                    //获取所有参数
                                                   var option = uiStepbar.option();
                                            
                                                   //获取某个参数
                                                   var id = uiStepbar.option( "id" );
                                            
                                                   //修改一个参数
                                                   uiStepbar.option( "click",false );
                                            
                                                   //修改多个参数
                                                   uiStepbar.option( {"click":false} );
                                            

prev

()

上一步

Example:

       //上一步
                                                   uiStepbar.prev();
                                            

value

(
  • [index] [设置值]
  • [status] [1.5.6新增,支持设置状态样式名, 默认"success"]
)

设置或者获取值

Parameters:

  • [index] [设置值] Number optional
  • [status] [1.5.6新增,支持设置状态样式名, 默认"success"] String optional

Example:

       //设置值
                                                   uiStepbar.value(1);
                                                   
                                                   //获取值
                                                   var val = uiStepbar.value();
                                            

widget

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

获取依赖的控件

Parameters:

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

Example:

       //获取依赖控件
                                                   var uiStepbarWidget = uiStepbar.widget();
                                            

Events

off

Defined in src/scripts/ui/bui.stepbar.js:411

Available since 1.3.0

为控件取消绑定事件

Event Payload:

  • [type] [ 事件类型: "change"(改变时触发) | "next"(下一步时触发) | "prev"(上一步时触发)] String optional
  • [callback] [ 绑定的事件, this 为当前点击的菜单] Function optional

Example:

       uiStepbar.off("change");
                                            

on

Defined in src/scripts/ui/bui.stepbar.js:391

Available since 1.3.0

为控件绑定事件

Event Payload:

  • [type] [ 事件类型: "change"(改变时触发) | "next"(下一步时触发) | "prev"(上一步时触发)] String optional
  • [callback] [ 绑定的事件, this 为当前点击的菜单] Function optional

Example:

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