black-lamp/yii2-slider

Module for adding image slider to site across dashboard

2.0.1 2017-09-10 14:06 UTC

Requires

• black-lamp/yii2-text-editor: 1.*.*
• bower-asset/slick-carousel: 1.6.0
• yiisoft/yii2: ^2.0.4
• yiisoft/yii2-bootstrap: ^2.0.0

Requires (Dev)

• codeception/codeception: *
• codeception/specify: *
• codeception/verify: *

BSD-3-Clause

• Vladimir Kuprienko

• module
• slider
• carousel
• yii2
• slick

README

Module for adding the image slider to site across dashboard and append it to view with widget help. This extension uses Slick slider.

Installation

Run command

composer require black-lamp/yii2-slider

or add

"black-lamp/yii2-slider": "*"

to the require section of your composer.json.

Applying migrations

yii migrate --migrationPath=@vendor/black-lamp/yii2-slider/src/common/migrations

Add module to application config

Module for backend

'modules' => [
     // ...
     'slider' => [
         'class' => bl\slider\backend\Module::class
     ]
]

Module configuration properties

Option	Description	Type	Default
imagesRoot	Path to images catalog in web folder (need for uploading images to the server across dashboard)	string	@frontend/web/img/slider
urlSeparator	Separator for getting url to image from image path	string	web
imagePrefix	Prefix for uploaded images (need for uploading images to the server across dashboard)	string	slider

Using

You should use the widget for adding the slider to the page

<?= bl\slider\frontend\widgets\SliderWidget::widget([
        'sliderKey' => 'home-page-slider'
    ]) ?>

Widget configuration properties

Option	Description	Type	Default
sliderKey	Unique slider key	string	-
imagePattern	Pattern for image	string	<div style="background: url({url}) {params} no-repeat; background-size: cover; height: 400px;"></div>
slickSliderOptions	Slider plugin configuration array.For more information read official Slick slider documentation.	array	['slidesToShow' => '3', 'slidesToScroll' => '1', 'autoplay' => 'true', 'autoplaySpeed' => '2000']

Also you can append this slider to your Active Record model

Configuration

Add behavior to your Active Record model

use yii\db\ActiveRecord;

/**
 * @property string $sliderKey
 * @property SliderContent[] $sliderContent
 */
class Article extends ActiveRecord
{
    public function behaviors()
    {
        return [
            // ...
            'slider' => [
                'class' => \bl\slider\common\behaviors\SliderBehavior::class
            ],
        ];
    }
}

Using

$article = new Article();
$article->sliderKey = "article-slider";

$slide_one = new SliderContent();
$slide_one->content = "img/slider/slider-1.jpg";
$slide_one->position = 1;

$slide_two = new SliderContent();
$slide_two->content = "img/slider/slider-2.jpg";
$slide_two->position = 2;

// slide N...

$article->sliderContent = $slide_one;
$article->sliderContent = $slide_two;
// or
$article->sliderContent = [$slide_one, $slide_two];

$article->save();