BUI

其它版本:

API for BUI 1.6.x

Show:

bui.rating Class

Module: UI

星级评分

支持一颗星,支持半颗星, 调用show方法的时候,星星可以是按百分比显示.

预览地址: demo

方法说明:

show: 展示评分的星星值,支持百分比
value: 不传参则获取,传参则设置
disabled: 更改为展示星星
option: 获取设置参数
widget: 获取依赖控件
控件预览

Constructor

bui.rating

(
  • option
)

Parameters:

  • option Object
    • id String

      控件id

    • [handle] String optional

      点击的区域,属于循环的那部分

    • [half] Boolean optional

      是否支持半颗星

    • [stars] Number optional

      显示多少颗星星

    • [value] Number optional

      初始化多少颗星星

    • [show] Number optional

      展示多少颗星星比如 3.6 最后一颗星星会转换成60%

    • [disabled] Boolean optional

      是否只读

    • [render] Boolean optional

      true | false 默认true,这样无需填写复杂的结构

    • [onBeforeInit] Function optional

      1.5.1新增 初始化前触发

    • [onInited] Function optional

      1.5.1新增 初始化以后触发

    • [onChange] Function optional

      1.6.0 每次改变才触发

    • [callback] Function optional

      点击按钮的回调

Example:

html:

       <div id="rating" class="bui-rating"></div>
                                    

js:

       // 初始化
                                           var uiRating = bui.rating({
                                                       id:'#rating'
                                                   });
                                           //获取值
                                           uiRating.value(); 
                                    

Item Index

Events

Methods

destroy

(
  • [bool]
)

Defined in src/scripts/ui/bui.rating.js:421

Available since 1.4.2

[销毁控件]

Parameters:

  • [bool] Boolean optional

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

Example:

       //销毁
                                                       uiRating.destroy();
                                                

disabled

() chainable

禁止评分

Example:

       //禁止评分
                                                       uiRating.disabled();
                                                

enabled

() chainable

Defined in src/scripts/ui/bui.rating.js:400

Available since 1.6.2

允许评分

Example:

       //允许评分
                                                       uiRating.enabled();
                                                

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 = uiRating.option();
                                                
                                                       //获取某个参数
                                                       var id = uiRating.option( "id" );
                                                
                                                       //修改一个参数
                                                       uiRating.option( "half",false );
                                                
                                                       //修改多个参数
                                                       uiRating.option( {"half":false} );
                                                

reset

()

Defined in src/scripts/ui/bui.rating.js:334

Available since 1.6.2

重置

Example:

      //重置
                                                      uiRating.reset();
                                                

show

(
  • [num]
)
chainable

展示评分的星星值,只读,支持星星的百分比展示

Parameters:

  • [num] String optional

    设置值

Example:

      //设置值
                                                      uiRating.show(3);
                                                

value

(
  • [num]
)

设置星星的值

Parameters:

  • [num] Number optional

    设置值

Example:

      //设置值
                                                      uiRating.value(3);
                                                
                                                      //获取值
                                                      var val = uiRating.value();
                                                

widget

(
  • [name]
)

获取依赖的控件

Parameters:

  • [name] String optional

    依赖控件名

Example:

       //获取依赖控件
                                                       var uiRatingWidget = uiRating.widget();
                                                

Events

off

Defined in src/scripts/ui/bui.rating.js:504

Available since 1.3.0

为控件取消绑定事件

Event Payload:

  • [type] String optional

    事件类型: "change"

  • [callback] Function optional

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

Example:

       uiRating.off("show");
                                                

on

Defined in src/scripts/ui/bui.rating.js:484

Available since 1.3.0

为控件绑定事件

Event Payload:

  • [type] String optional

    事件类型: "change"

  • [callback] Function optional

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

Example:

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