BUI

其它版本:

API for BUI 1.5.4

Show:

bui.searchbar Class

搜索条

输入时会延迟执行.示例是 searchbar 跟 list 一起使用的场景.

预览地址: demo

方法说明:

search: 单独调用搜索方法
option: 获取设置参数
widget: 获取依赖控件
控件预览

Constructor

bui.searchbar

(
  • option
)

Parameters:

  • option Object
    • id String

      [控件id]

    • [handle] String optional

      [点击的搜索按钮]

    • [onInput] Function optional

      [ 实时搜索的回调 ]

    • [onChange] Function optional

      [ 1.5.4新增, 搜索改变的时候触发,在失去焦点后 ]

    • [onRemove] Function optional

      [ 移除关键词以后的回调 ]

    • [onBeforeInit] Function optional

      [ 1.5.1新增 初始化前触发 ]

    • [onInited] Function optional

      [ 1.5.1新增 初始化以后触发 ]

    • [callback] Function optional

      [ 点击按钮的回调 ]

Example:

html:

       <div id="searchbar" class="bui-searchbar">
           <div class="bui-input">
               <i class="icon-search"></i>
               <input type="text" value="" placeholder="搜索"/>
           </div>
       </div>

js:

       // 初始化
       var uiSearchbar = bui.searchbar({ 
           id: "#searchbar",
           callback: function(e,keyword) {
               // 点击以后做什么事情
           }
         });

Item Index

Events

Methods

destroy

(
  • [bool]
)

[销毁控件]

Parameters:

  • [bool] Boolean optional

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

Example:

       //销毁
       uiSearchbar.destroy();

init

(
  • [option]
)
chainable

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

Parameters:

  • [option] Object optional

    [参数控件本身]

option

(
  • [key]
  • [value]
)
chainable

获取设置参数

Parameters:

  • [key] String | object optional

    [ 不传则获取所有参数, 类型为string,没有第2个参数则获取某个参数 ]

  • [value] String | number | boolean | function optional

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

Example:

       //获取所有参数
       var option = uiSearchbar.option();

       //获取某个参数
       var id = uiSearchbar.option( "id" );

       //修改一个参数
       uiSearchbar.option( "handle",".btn-search" );

       //修改多个参数
       uiSearchbar.option( {"handle":".btn-search"} );

reset

(
  • [name]
)

清空当前输入框的值

Parameters:

  • [name] String optional

    [ 依赖控件名 ]

Example:

      uiSearchbar.reset();

value

(
  • [name]
)

获取当前输入框的值

Parameters:

  • [name] String optional

    [ 依赖控件名 ]

Example:

      var val = uiSearchbar.value();

widget

(
  • [name]
)

获取依赖的控件

Parameters:

  • [name] String optional

    [ 依赖控件名 ]

Example:

       //获取依赖控件
       var uiSearchbarWidget = uiSearchbar.widget();

Events

off

为控件取消绑定事件

Event Payload:

  • [type] String optional

    [ 事件类型: "search"(搜索时触发) | "remove"(移除关键字时触发) | "input"(每次输入时触发) ]

  • [callback] Function optional

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

Example:

       uiSearchbar.off("show");

on

为控件绑定事件

Event Payload:

  • [type] String optional

    [ 事件类型: "search"(搜索时触发) | "remove"(移除关键字时触发) | "input"(每次输入时触发) ]

  • [callback] Function optional

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

Example:

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