tt-carousel

Carousel. Responsive. Webpack compatibility. Support touch screen.

Getting started

1. Using npm.

   • npm install tt-carousel.
   • If you are using webpack, then import {Carousel} from 'tt-carousel'.
   • Include tt.min.css in your bundle.
   • Instantiate new Carousel with options.

       let carouselInstance = new Carousel({
           slidesToShow:5,
           container: document.querySelector('.carousel'),
           responsive: [
               {
                   breakpoint: 1200,
                   slidesToShow:4,
               },
               {
                   breakpoint: 991,
                   slidesToShow:3,
               },
               {
                   breakpoint: 768,
                   slidesToShow:2,
               },
               {
                   breakpoint: 450,
                   slidesToShow:1
               }
           ]
       });

   • Carousel waite until DOMContentLoaded event. If you miss event you can call carouselInstance.init() manually.

2. Include tag script

   • Include tag script before closed </body> (<script type="text/javascript" src="tt.min.js"></script>).
   • Include tt.min.css in head of page (<link href="tt.min.css" rel="stylesheet">).

       let carouselInstance = new tt.Carousel({
           slidesToShow:5,
           container: document.querySelector('.carousel'),
           responsive: [
               {
                   breakpoint: 1200,
                   slidesToShow:4,
               },
               {
                   breakpoint: 991,
                   slidesToShow:3,
               },
               {
                   breakpoint: 768,
                   slidesToShow:2,
               },
               {
                   breakpoint: 450,
                   slidesToShow:1
               }
           ]
       });

   • Carousel waite until DOMContentLoaded event. If you miss event you can call carouselInstance.init() manually.

3. html structure. Use any class name as you want. You have to pass class name of container to options. In this particular case { container: document.querySelector('.carousel') }

       <div class="carousel">
           <div class="carousel__item">1</div>
           <div class="carousel__item">2</div>
           <div class="carousel__item">3</div>
           <div class="carousel__item">4</div>
           <div class="carousel__item">5</div>
           <div class="carousel__item">6</div>
       </div>

Responsive

Carousel can change options based on responsive array. It can be destroed and rebuilt by boolean option initiate. Here on wide screen carousel is not built. Between 1200px and 991px it is built and less then 991px destroed.

        let carouselInstance = new tt.Carousel({
            initiate:false,
            container: document.querySelector('.carousel'),
            responsive: [
                {
                    breakpoint: 1200,
                    initiate:true
                },
                {
                    breakpoint: 991,
                    initiate:false
                }
            ]
        });

Options

container (required)

assign result of document.querySelector(className), where className of parent div of slides. For example container: document.querySelector('.carousel')

    <div class="carousel">
        <div class="carousel__item">1</div>
        <div class="carousel__item">2</div>
        <div class="carousel__item">3</div>
        <div class="carousel__item">4</div>
        <div class="carousel__item">5</div>
        <div class="carousel__item">6</div>
    </div>

initiate (default: true)

if initiate:false then carousel is destroed

responsive (default: [] empty array)

responsive is array of objects. Each object must have breakpoint property. Only one object will be selected and merged with options (if window width less then breakpoint).

arrows (default: true)

enable left/right buttons (div, which you may style by background)

dots (default: true)

enable dots navigaton

slidesToShow (default: 1)

quantity of slides in view

speed (default: 300)

transition speed (ms)