Logo Logo

Documentation v1.0.2

Preview
Light
Dark
System

Overview

Fullscreen Lightbox, is en easy to use, but powerful plugin for displaying various types of sources in beautiful overlaying box with tons of features such as captions, thumbnails, zooming and more! Present single source or create beautiful gallery with stylish lightbox without jQuery! For more info see the official siteand the Github repository.

Usage

Fullscreen Lightbox's Javascript files are bundled in a custom bundle file and included on demand as shown below: 
<script src="assets/plugins/custom/fslightbox/fslightbox.bundle.js"></script>

Initialization

  • Fullscreen Lightbox's CSS is highly customized in sass/vendors/plugins/_fslightbox.scss SCSS file in order to use it as a native component within the design system. The SCSS code is compiled into assets/plugins/global/plugins.bundle.css and globally included in all pages.

Basic

Every <a> tag with data-fslightbox attribute opens a lightbox. Value of href attribute will be shown in your box. 
<!--begin::Overlay-->
<a class="d-block overlay" data-fslightbox="lightbox-basic" href="assets/media/stock/900x600/23.jpg">       
    <!--begin::Image-->
    <div class="overlay-wrapper bgi-no-repeat bgi-position-center bgi-size-cover card-rounded min-h-175px"
        style="background-image:url('assets/media/stock/900x600/23.jpg')">                       
    </div>
    <!--end::Image-->

    <!--begin::Action-->
    <div class="overlay-layer card-rounded bg-dark bg-opacity-25 shadow">
        <i class="bi bi-eye-fill text-white fs-3x"></i>    
    </div>  
    <!--end::Action-->      
</a>  
<!--end::Overlay-->

Video

Fullscreen Lightbox supports, Youtube, HTML5 and videos from custom sources as well(Vimeo, etc): 
<!--begin::Youtube-->
<a 
    class="d-block bgi-no-repeat bgi-size-cover bgi-position-center rounded position-relative min-h-175px" 
    style="background-image:url('assets/media/stock/600x400/img-23.jpg')"                        
    data-fslightbox="lightbox-youtube" 
    href="https://www.youtube.com/embed/xshEZzpS4CQ"
    >   
    <!--begin::Icon-->
    <img src="assets/media/svg/misc/video-play.svg"  class="position-absolute top-50 start-50 translate-middle" alt=""/>
    <!--end::Icon-->
</a> 
<!--end::Youtube-->

<!--begin::HTML5-->
<a 
    class="d-block bgi-no-repeat bgi-size-cover bgi-position-center rounded position-relative min-h-175px" 
    style="background-image:url('assets/media/stock/600x400/img-25.jpg')"                        
    data-fslightbox="lightbox-html5" 
    href="http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"
    >   
    <!--begin::Icon-->
    <img src="assets/media/svg/misc/video-play.svg"  class="position-absolute top-50 start-50 translate-middle" alt=""/>
    <!--end::Icon-->
</a> 
<!--end::HTML5-->

<!--begin::Custom source(Vimeo)-->
<a 
    class="d-block bgi-no-repeat bgi-size-cover bgi-position-center rounded position-relative min-h-175px" 
    style="background-image:url('assets/media/stock/600x400/img-26.jpg')"     
    data-class="d-block"                   
    data-fslightbox="lightbox-vimeo" 
    href="#vimeo"
    >   
    <!--begin::Icon-->
    <img src="assets/media/svg/misc/video-play.svg"  class="position-absolute top-50 start-50 translate-middle" alt=""/>
    <!--end::Icon-->
</a> 

<iframe id="vimeo" style="display:none" src="https://player.vimeo.com/video/22439234" width="1920px" height="1080px" frameBorder="0" allow="autoplay; fullscreen" allowFullScreen></iframe>
<!--end::Custom source(Vimeo)-->
Preview Get Help Buy Now