Getting Started
Components
- Animated Number
- Auto Submit
- Carousel
- Character Counter
- Chartjs
- Checkbox Select All
- Clipboard
- Color Picker
- Content Loader
- Dialog
- Dropdown
- Glow
- Lightbox
- Notification
- Password Visibility
- Places Autocomplete
- Popover
- Prefetch
- Rails Nested Form
- Read More
- Remote Rails
- Reveal Controller
- Scroll Progress
- Scroll Reveal
- Scroll To
- Sortable
- Sound
- Textarea Autogrow
- Timeago
Installation
Install the package
$ yarn add @stimulus-components/carousel
Register the controller in your application
app/javascript/controllers/index.jsimport { 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:
import 'swiper/css/bundle'
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-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
Attribute | Default | Description | Optional |
---|---|---|---|
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:
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.