stimulus-carousel

Stimulus Carousel

Getting started

A Stimulus controller to deal with carousel.

This controller is using Swiper behind the scene.

Installation

$ yarn add stimulus-carousel

And use it in your JS file:

import { Application } from "stimulus"
import Carousel from "stimulus-carousel"

const application = Application.start()
application.register("carousel", Carousel)

Usage

Before starting, your must import the Swiper CSS in your js or in your sass:

// In your application.js (for example)
import 'swiper/swiper-bundle.min.css'

// Or in your sass
@import "~swiper/swiper-bundle"

Basic usage:

<div data-controller="carousel" class="swiper-container">
  <div class="swiper-wrapper">
    <div class="swiper-slide">Slide 1</div>
    <div class="swiper-slide">Slide 2</div>
    <div class="swiper-slide">Slide 3</div>
  </div>
</div>

With options:

<div
  data-controller="carousel"
  class="swiper-container"
  data-carousel-options="{'direction': 'vertical'}"
>
  <div class="swiper-wrapper">
    <div class="swiper-slide">Slide 1</div>
    <div class="swiper-slide">Slide 2</div>
    <div class="swiper-slide">Slide 3</div>
  </div>
</div>

Configuration

Attribute	Default	Description	Optional
data-carousel-options	{}	Options for lightgallery.js as JSON string.	✅

Extending Controller

You can use inheritance to extend the functionality of any Stimulus component.

import Carousel from "stimulus-carousel"

export default class extends Carousel {
  connect() {
    super.connect()
    console.log("Do what you want here.")

    // The swiper instance.
    this.swiper

    // Default options for every carousels.
    this.defaultOptions

    // Options from data attribute.
    this.options
  }

  // You can set default options in this getter.
  get defaultOptions () {
    return {
      // Your default options here
    }
  }
}

This controller will automatically have access to targets defined in the parent class.

If you override the connect, disconnect or any other methods from the parent, you'll want to call super.method() to make sure the parent functionality is executed.

Development

Project setup

$ yarn install
$ yarn dev

Linter

Prettier and ESLint are responsible to lint and format this component:

$ yarn lint
$ yarn format

Contributing

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

License

This project is released under the MIT license.