Components

Stimulus Carousel

A Stimulus controller to deal with carousel.


Installation

  1. Install the package

    $ yarn add @stimulus-components/carousel
    
  2. Register the controller in your application

    app/javascript/controllers/index.js
    import { Application } from '@hotwired/stimulus'
    import Carousel from '@stimulus-components/carousel'
    
    const application = Application.start()
    application.register('carousel', Carousel)
    

This component is based on the Swiper.

Before starting

You must import the Swiper CSS in your js file:

app/javascript/index.js
import 'swiper/css/bundle'

Usage

app/views/index.html
<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:

app/views/index.html
<div data-controller="carousel" class="swiper-container" data-carousel-options-value='{"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

AttributeDefaultDescriptionOptional
data-carousel-options-value{}Options for swiper.js as JSON string.βœ…

Extending Controller

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

app/javascript/controllers/carousel_controller.js
import Carousel from '@stimulus-components/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
  }

  // 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.

Sponsors

Stimulus Component is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support Stimulus Components development on GitHub Sponsors. πŸ™

Contributing

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

Don't forget to drop a 🌟 on GitHub to support the project.

License

This project is released under the MIT license.