Bootstrap 5 Lightbox

What is Bootstrap Lightbox?

Lightbox is a responsive gallery with the option to enlarge selected photos.

Installation

Manual installation (zip package)

To take advantage of our Bootstrap images component and use them in your project, you first need to install the MDB 5 Free package

MDB CLI

Watch our Quick Start Tutorial to discover and use the full potential of MDB 5 and MDB CLI

NPM

Prerequisites

Before starting the project make sure to install Node LTS (12.x.x recommended).

Installation

To install MDB UI KIT in your project easily type the following command in the terminal:

npm i mdb-ui-kit

Importing JS modules

You can import the entire library or just individual modules:

import * as mdb from 'mdb-ui-kit'; // lib
import { Input } from 'mdb-ui-kit'; // module

Importing CSS file

To import MDB stylesheet please use the following syntax:

@import '~mdb-ui-kit/css/mdb.min.css';

Importing SCSS modules

You can also import individual SCSS modules. To do it properly, we recommend to copy them from the node_modules/mdb-ui-kit/src/scss location directly to your project and import in the same way as CSS files.

Webpack integration

You can significantly speed up the process of creating a new project based on Webpack using our Starter.

CDN

Installation via CDN is one of the easiest methods of integrating MDB UI KIT with your project. Just copy the latest compiled JS script tag and CSS link tag from cdnjs to the application.

Don't forget to add also Font Awesome and Roboto font if you need. Here's an example code:

CSS

<!-- Font Awesome -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css"
  rel="stylesheet"
/>
<!-- Google Fonts -->
<link
  href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap"
  rel="stylesheet"
/>
<!-- MDB -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.css"
  rel="stylesheet"
/>

JS

<!-- MDB -->
<script
  type="text/javascript"
  src="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.js"
></script>

Customization

Basic example

A basic example of a lightbox with the most common use case with the bootstrap grid.

HTML

<div class="lightbox">
  <div class="row">
    <div class="col-lg-4">
      <img
        src="https://mdbootstrap.com/img/Photos/Thumbnails/Slides/1.jpg"
        data-mdb-img="https://mdbootstrap.com/img/Photos/Slides/1.jpg"
        alt="Lightbox image 1"
        class="w-100"
      />
    </div>
    <div class="col-lg-4">
      <img
        src="https://mdbootstrap.com/img/Photos/Thumbnails/Slides/2.jpg"
        data-mdb-img="https://mdbootstrap.com/img/Photos/Slides/2.jpg"
        alt="Lightbox image 2"
        class="w-100"
      />
    </div>
    <div class="col-lg-4">
      <img
        src="https://mdbootstrap.com/img/Photos/Thumbnails/Slides/3.jpg"
        data-mdb-img="https://mdbootstrap.com/img/Photos/Slides/3.jpg"
        alt="Lightbox image 3"
        class="w-100"
      />
    </div>
  </div>
</div>

Image optimization

To ensure the proper performance of the page, it is recommended to include thumbnails of images in the src attribute. Then in the data-mdb-img attribute add the path to the image with higher resolution. If the data-mdb-img attribute is omitted, the lightbox will display the same image as in the reduced size.

HTML

<img src="https://mdbootstrap.com/img/Photos/Thumbnails/Slides/1.jpg"
  data-mdb-img="https://mdbootstrap.com/img/Photos/Slides/1.jpg" alt="Lightbox image 1"
  class="w-100" />

You can see more customization examples on the 📄 Lightbox documentation page

Crucial Resources

Here are the resources that we have prepared to help you work with this component:

Read 📄 Lightbox documentation page <-- start here
In to get the most out of your project, you should also get acquainted with other Components options related to Lightbox. See the section below to find the list of them.
You can use predesigned Components elements in 📥 Starter Bootstrap 5 templates
Templates are a part of 📦 Free UI Kit for Bootstrap 5
After finishing the project you can publish it with CLI in order to receive 💽 Free hosting (beta)