Plugins

Yet Another React Lightbox allows you to add optional features to your project based on your requirements via plugins.

The following plugins are bundled in the package:

  • Captions - adds support for slide title and description
  • Counter - adds slides counter
  • Download - adds download button
  • Fullscreen - adds support for fullscreen mode
  • Inline - transforms the lightbox into an image carousel
  • Share - adds sharing button
  • Slideshow - adds slideshow button
  • Thumbnails - adds thumbnails track
  • Video - adds support for video slides
  • Zoom - adds image zoom feature

Each plugin can be imported either from the yet-another-react-lightbox/plugins module entrypoint:

// using named export
import { Fullscreen } from "yet-another-react-lightbox/plugins";

or from the plugin-specific entrypoint (this option is preferred in TypeScript projects):

// using named export
import { Fullscreen } from "yet-another-react-lightbox/plugins/fullscreen";

or

// using default export
import Fullscreen from "yet-another-react-lightbox/plugins/fullscreen";

Please refer to the individual plugin's documentation for additional details.

CodeSandbox

Edit on CodeSandbox