yii2-slick
Yii2 extension for jQuery Slick Carousel plugin. See more here: http://kenwheeler.github.io/slick/., (*1)
Installation
You can get this extension through Composer. There are two way:, (*2)
- Either run in terminal:
$ php composer.phar require "evgeniyrru/yii2-slick" "*"
- Or add:
"evgeniyrru/yii2-slick" : "*"
to the require section of your application's composer.json
file. Then run in terminal composer install command:, (*3)
$ php composer.phar install
Usage
This is a common way to run Yii2 widget., (*4)
Something html here
=Slick::widget([
// HTML tag for container. Div is default.
'itemContainer' => 'div',
// HTML attributes for widget container
'containerOptions' => ['class' => 'container'],
// Position for inclusion js-code
// see more here: http://www.yiiframework.com/doc-2.0/yii-web-view.html#registerJs()-detail
'jsPosition' => yii\web\View::POS_READY,
// It possible to use Slick.js events
// see more: http://kenwheeler.github.io/slick/#events
'events' => [
'edge' => 'function(event, slick, direction) {
console.log(direction);
// left
});'
],
// Items for carousel. Empty array not allowed, exception will be throw, if empty
'items' => [
Html::img('/cat_gallery/cat_001.png'),
Html::img('/cat_gallery/cat_002.png'),
Html::img('/cat_gallery/cat_003.png'),
Html::img('/cat_gallery/cat_004.png'),
Html::img('/cat_gallery/cat_005.png'),
],
// HTML attribute for every carousel item
'itemOptions' => ['class' => 'cat-image'],
// settings for js plugin
// @see http://kenwheeler.github.io/slick/#settings
'clientOptions' => [
'autoplay' => true,
'dots' => true,
// note, that for params passing function you should use JsExpression object
// but pay atention, In slick 1.4, callback methods have been deprecated and replaced with events.
'onAfterChange' => new JsExpression('function() {console.log("The cat has shown")}'),
],
]); ?>
If you want to use breakpoints feature, type something like this:, (*5)
[
'dots' => true,
'speed' => 300,
'autoplay' => true,
'infinite' => false,
'slidesToShow' => 4,
'slidesToScroll' => 4,
'responsive' => [
[
'breakpoint' => 1200,
'settings' => [
'slidesToShow' => 4,
'slidesToScroll' => 4,
'infinite' => true,
'autoplay' => true,
'dots' => true,
],
],
[
'breakpoint' => 992,
'settings' => [
'slidesToShow' => 4,
'slidesToScroll' => 4,
'infinite' => true,
'autoplay' => true,
'dots' => true,
],
],
[
'breakpoint' => 768,
'settings' => [
'slidesToShow' => 2,
'slidesToScroll' => 2,
'infinite' => true,
'autoplay' => true,
'dots' => true,
],
],
[
'breakpoint' => 480,
'settings' => 'unslick', // Destroy carousel, if screen width less than 480px
],
],
],
]); ?>
?>
Issues
If some problems occurred, you can create issue., (*6)
Thank you for attention., (*7)