alfa6661/yii2-raty

Yii2 wrapper for jQuery Raty plugin

yii2-raty

, _(*1)

Yii2-raty is a wrapper for jQuery Raty plugin. jQuery Raty is a plugin that generates a customizable star rating automatically., _(*2)

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

php composer.phar require --prefer-dist alfa6661/yii2-raty "*"

or add, _(*5)

"alfa6661/yii2-raty": "*"

to the require section of your composer.json file., _(*6)

Usage

Once the extension is installed, simply use it in your code by :, _(*7)

// Usage
= \alfa6661\widgets\Raty::widget([
    'name' => 'user-vote',
    'options' => [
        // the HTML attributes for the widget container
    ],
    'pluginOptions' => [
        // the options for the underlying jQuery Raty plugin
        // see : https://github.com/wbotelhos/raty#options
    ]
]); ?>


// Usage with model
= \alfa6661\widgets\Raty::widget([
    'model' => $model,
    'attribute' => 'rating',
    'options' => [
        // the HTML attributes for the widget container
    ],
    'pluginOptions' => [
        // the options for the underlying jQuery Raty plugin
        // see : https://github.com/wbotelhos/raty#options
    ]
]); ?>

// Usage with ActiveForm and model
= $form->field($model, 'point')->widget(\alfa6661\widgets\Raty::className(), [
    'options' => [
        // the HTML attributes for the widget container
    ],
    'pluginOptions' => [
        // the options for the underlying jQuery Raty plugin
        // see : https://github.com/wbotelhos/raty#options
    ]
]); ?>

// Javascript events handling
// Available event callbacks: Read Only, Click, Mouseover and Mouseout
= \alfa6661\widgets\Raty::widget([
    'name' => 'user-vote',
    'options' => [
        'class' => 'pull-left',
        'id' => 'user-vote'
    ],
    'pluginOptions' => [
        'click' => new \yii\web\JsExpression('function(score, e) {
            alert(score);
        }')
    ]
]); ?>