panix/wgt-owlcarousel

Widget Owl Carousel

dev-master 2021-02-01 10:57 UTC

Requires

• bower-asset/owl.carousel: ^2.3.4

MIT

• PIXELION CMS

• extension
• widget
• owlcarousel
• pixelion-cms

README

The OwlCarouselWidget is a Yii2 wrapper for the [Owl Carousel 2] (https://owlcarousel2.github.io/OwlCarousel2/)

Installation

The preferred way to install this extension is through composer.

Either run

php composer require --prefer-dist panix/wgt-owlcarousel "*"

or add

"panix/wgt-owlcarousel": "*"

to the require section of your composer.json file.

Plugin options

see at https://owlcarousel2.github.io/OwlCarousel2/docs/api-options.html

Usage

Once the extension is installed, simply use it in your code by :

<?php
use panix\ext\owlcarousel\OwlCarouselWidget;

OwlCarouselWidget::begin([
    'containerTag' => 'div',
    'containerOptions' => [
        'class' => 'container-class'
    ],
    'options'    => [
        'autoplay'          => true,
        'autoplayTimeout'   => 3000,
        'items'             => 3,
        'loop'              => true,
        'responsiveClass' => true,
        'responsive' => [
            0 => [
                'items' => 1,
                'nav' => false,
                'dots' => true,
                'center' => true,
            ],
            426 => [
                'items' => 2,
                'nav' => false
            ],
            768 => [
                'items' => 2,
                'nav' => false
            ],
            1024 => [
                'items' => 5,
                'nav' => true,
                'dots' => false
            ]
        ]
    ]
]);
?>

<div class="item-class"><img src="/img/1.jpg" alt="Image 1"></div>
<div class="item-class"><img src="/img/2.jpg" alt="Image 2"></div>
<div class="item-class"><img src="/img/3.jpg" alt="Image 3"></div>
<div class="item-class"><img src="/img/4.jpg" alt="Image 4"></div>


<?php OwlCarouselWidget::end(); ?>