This component is available on GitHub.

Stimulus Lightbox

A Stimulus controller to add a lightbox on images.

This controller is using lightgalleryjs behind the scene.

Installation

$ yarn add stimulus-lightbox

And use it in your JS file:

// Probably in app/javascript/controllers/index.js

import { Application } from '@hotwired/stimulus'
import Lightbox from 'stimulus-lightbox'

const application = Application.start()
application.register('lightbox', Lightbox)

Usage

Before starting, your must import the lightgallery.css in your js or in your sass:

// In your application.js (for example)
import 'lightgallery/css/lightgallery.css'

// Or in your sass
@import '~lightgallery/scss/lightgallery'

Basic usage:

<div data-controller="lightbox">
  <a href="img/img1.jpg">
    <img src="img/img1.jpg" alt="" />
  </a>

  <a href="img/img2.jpg">
    <img src="img/img2.jpg" alt="" />
  </a>

  <a href="img/img3.jpg">
    <img src="img/img3.jpg" alt="" />
  </a>
</div>

With options:

<div data-controller="lightbox" data-lightbox-options-value='{"index": 2}'>
  <a href="img/img1.jpg">
    <img src="img/img1.jpg" alt="" />
  </a>

  <a href="img/img2.jpg">
    <img src="img/img2.jpg" alt="" />
  </a>

  <a href="img/img3.jpg">
    <img src="img/img3.jpg" alt="" />
  </a>
</div>

🛠 Configuration

AttributeDefaultDescriptionOptional
data-lightbox-options-value{}Options for lightgallery.js as JSON string.✅

🎛 Extending Controller

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

import Lightbox from 'stimulus-lightbox'

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

    // Get the lightgallery instance
    this.lightGallery

    // Default options for every lightboxes.
    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.