kl83/yii2-rating-widget

Allows you to set an stars-rating for something or show it.

Yii2 rating widget

, _(*1)

Allows you to set an stars-rating for something or show it., _(*2)

Installation

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

Either run, _(*4)

php composer.phar require kl83/yii2-rating-widget ^2.0

or add, _(*5)

"kl83/yii2-rating-widget": "^2.0"

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

Usage

FontAwesome asset is used to display stars. Version 4.7 is in use. If you do not have it in your project, \kl83\widgets\RatingWidgetFaAsset asset must be registered., _(*7)

~~~ php \kl83\widgets\RatingWidgetFaAsset::register(\Yii::$app->view);, _(*8)

### Input widget

~~~ php
$form->field($model, 'rating')->widget('kl83\widgets\RatingInput', [
    'containerOptions' => ['class' => 'some-class'], // HTML attributes
    'maxRating' => 10, // stars count, default - 5
]);

~~~ javascript // Sets 5 stars rating jQuery('.widget').ratingInput('set', 5);, _(*9)

### Display widget

~~~ php
\kl83\widgets\RatingWidget::widget([
    'maxRating' => 10, // stars count, default - 5
    'options' => ['class' => 'some-class'], // HTML attributes
    'value' => 4.5, // highlighted stars count
]);

~~~ javascript // Initialize widget jQuery('.widget').ratingWidget(); // Sets 5 stars rating jQuery('.widget').ratingWidget('set', 5); ~~~, _(*10)

License

MIT License, _(*11)