Link Search Menu Expand Document

Netlify Status

This component is available on GitHub.

Stimulus Lightbox

A Stimulus controller to add a lightbox on images.

This controller is using lightgallery.js behind the scene.

Installation

$ yarn add stimulus-lightbox

And use it in your JS file:

import { Application } from "stimulus"
import Lightbox from "stimulus-lightbox"

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

πŸ‘€ Demo

See Demo

Usage

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

// In your application.js (for example)
import "lightgallery.js/dist/css/lightgallery.min.css"

// Or in your sass
@import "~lightgallery.js/src/sass/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

Attribute Default Description Optional
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.")

    // Default options for every lightboxes.
    this.defaultOptions

    // The lightGallery instance.
    this.lightGallery
  }

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

🍻 Support

You can support my work 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.

πŸš€ Releasing

$ yarn pika:publish

πŸ“ License

This project is released under the MIT license.