React video gallery

lightGallery supports YouTube, Vimeo, Wistia and all other types of HTML5 video formats. Such as MP4, WebM, Ogg, etc. into a full-fledged lightbox gallery.

External videos

To display YouTube, Vimeo and Wistia, videos, you just need to paste the video URL, or share URL of the video in the data-src attribute. The same way you display images in the gallery. lightGallery will check the data-src attribute and if it is a video URL, it will create the respective video slide.

You can also provide poster image for each videos. Poster images will be loaded instead of videos. So user will be able to navigate to other slides by using mouse drag or swipe. Poster images improve performance, and maintain the flexibility of your gallery without effecting user experience. Videos will be loaded when a user clicks on the poster images. You can place poster image url in the data-poster attribute.

lightGallery allows you to load thumbnail images automatically from YouTube and Vimeo. You can specify the size of the thumbnails in the settings. You need to use Vimeo thumbnail plugin to load thumbnails for vimeo videos. Videos will be automatically paused when a user starts to navigate to another slide.

HTML5 videos

For displaying HTML5 videos, you need to construct an object with array of video sources and types, and videos attributes objects as shown below and pass it via data-video attribute

Note - data-src should not be provided when you use html5 videos


import { FC, useCallback, useEffect, useRef, useState } from 'react';
import { LightGallery as ILightGallery } from 'lightgallery/lightgallery';
import LightGallery from 'lightgallery/react';
import lgVideo from 'lightgallery/plugins/video';
import lgThumbnail from 'lightgallery/plugins/thumbnail';
import 'lightgallery/css/lightgallery.css';
import 'lightgallery/css/lg-thumbnail.css';
import 'lightgallery/css/lg-video.css';
import './style.scss';

export const App: FC<{ name: string }> = ({ name }) => {
    const lightGalleryRef = useRef < ILightGallery > null;
    const containerRef = useRef(null);
    const [galleryContainer, setGalleryContainer] = useState(null);

    const onInit = useCallback((detail) => {
        if (detail) {
            lightGalleryRef.current = detail.instance;
            // Since we are using dynamic mode, we need to programmatically open lightGallery
    }, []);

    useEffect(() => {
        if (containerRef.current) {
    }, []);

    const videos = [
            src: '',
            subHtml: `<h4>'Peck Pocketed' by Kevin Herron | Disney Favorite</h4>`,
            src: '',
            subHtml: `<h4>Forest Path - Unreal Engine 5 Cinematic by Sharkyy</h4>`,
            src: '',
            subHtml: `<h4>UE5 | In The Heart Of The Forest by Anastasia Gorban</h4>`,
        // Add more video objects as needed

    return (
            <div ref={containerRef} />
                plugins={[lgThumbnail, lgVideo]}
                // videojs
                // videojsOptions={{ muted: false }}

Set height and width for the container as the inline automatically adopts the container size

.inline-gallery-container {
    width: 100%;

    // set 60% height
    height: 0;
    padding-bottom: 65%;

Edit this page on GitHub