dodecastudio/craft-lightbox

A simple, responsive, accessible and customisable lightbox gallery that integrates seamlessly with Craft CMS.

2.0.0 2024-04-22 14:17 UTC

Requires

• php: >=7.4
• craftcms/cms: ^3.0|^4.0|^5.0

proprietary

• Dodeca Studio

• assets
• cms
• images
• gallery
• lightbox
• Craft
• craftcms
• craft-plugin

README

Craft Lightbox renders a simple and lightweight lightbox that is both responsive and accessible. It's suitable for anyone seeking a quick plug-and-play lightbox solution without much setup required.

Requirements

• Craft CMS 3.X, 4.X or 5.X
• PHP 7.4+

Installation

Install the plugin as follows:

1. Open your terminal and go to your Craft project:

   cd /path/to/project
   

2. Then tell Composer to load the plugin:

   composer require dodecastudio/craft-lightbox
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Lightbox.

Getting started

The fastest way to take a look at the lightbox in action, is to copy the demo.twig file in to your project and view it in a browser. So long as you have some assets in your project, you should see some content on that page.

Otherwise, create an AssetQuery and give it to lightbox's gallery method. Then include lightbox's render method like so:

{# Fetch some images #}
{% set myAssetQuery = craft.assets().kind("image").limit(20) %}

{# Display the images in a gallery #}
{{ craft.lightbox.gallery(myAssetQuery) }}

{# Embed the Lightbox on the page #}
{{ craft.lightbox.render() }}

Please see the Craft Lightbox Docs for a complete guide, including more templating examples and full details on configuration.