Vue Lightbox

Vue Lightbox component

Responsive lightbox built with the latest Bootstrap 5 and Vue 3. Lightbox is a responsive gallery with the option to enlarge selected photos.

MDB lightbox is a group of images combined in one responsive gallery. Elements are grouped in a thumbnail grid, which can be displayed as a slideshow.

Note: Read the API tab to find all available options and advanced customization


Basic example

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


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 fullScreenSrc property add the path to the image with higher resolution. If the fullScreenSrc property is omitted, the lightbox will display the same image as in the reduced size.


Shadows and rounded corners

You can improve the look of the images by adding shadows and rounded corners.


Different sizes

Loaded images can have any aspect ratio. Their size will be automatically adjusted to the window when you open the lightbox.


Zoom level

The zoomLevel attribute allows you to define the size of a single zoom in / zoom out.


Disabled image

By adding a disabled property to the MDBLightboxItem component, you can exclude it from your lightbox. In the example below, the third image has been disabled.


Captions

Image captions can be added using the caption property on MDBLightboxItem. If it is not set, the data is taken from the alt attribute.


Outside access

The lightbox can be successfully operated via JavaScript. There are many public methods available such as open, slide, zoomIn, zoomOut, or close. All are described in the API tab.

Vue Lightbox - API


Import


        <script>
          import { 
            MDBLightbox,
            MDBLightboxItem,
          } from 'mdb-vue-ui-kit';
        </script>
      

Properties

MDBLightbox

Name Type Default Description
tag String 'div' Defines tag of the MDBLightbox element
zoomLevel Number | String Defines zoom level while zooming in or out.
fontAwesome Boolean 'free Defines version of Font Awesome library. Available options are 'free' and 'pro'.

MDBLightboxItem

Name Type Default Description
tag String 'img' Defines tag of the MDBLightboxItem element
fullScreenSrc String Defines regular image to load when gallery is open. If not set, the value of src attribute is taken.
caption String Defines caption of the image. If not set, the value of alt attribute is taken.
disabled Boolean false Sets image disabled and not showing in the lightbox

Methods

Name Parameters Description
open target Opens the gallery and activates image set by the target key. Default is the first image.
slide target Slides an image in the gallery. Available options: left, right, first, last. Dafault is right direction.
zoomIn Zooms in active image by one level.
zoomOut Zooms out active image by one level.
toggleFullscreen Toggles fullscreen.
reset Resets changed parameters such as position, zoom or fullscreen.
close Closes the gallery.

          <MDBLightbox ref="testLightbox"/>
          <MDBBtn @click.stop="$refs.testLightbox.open(1)" color="primary" size="sm">Open</MDBBtn>