yet-another-react-lightbox 1.4.1 → 1.5.0

package/dist/plugins/Video.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="react" />
-import { Plugin } from "../types.js";
+import * as React from "react";
+import { LightboxProps, Plugin } from "../types.js";
 /** Video slide attributes */
 export interface SlideVideo {
     /** video slide type marker */
@@ -10,6 +10,26 @@ export interface SlideVideo {
     width?: number;
     /** video height in pixels */
     height?: number;
+    /** if `true`, the video automatically begins to play */
+    autoPlay?: boolean;
+    /** if `true`, the browser will offer controls to allow the user to control video playback */
+    controls?: boolean;
+    /** indicates what controls to show */
+    controlsList?: string;
+    /** indicates whether to use CORS to fetch the related video */
+    crossOrigin?: string;
+    /** video preload setting */
+    preload?: string;
+    /** if `true`, the browser will automatically seek back to the start upon reaching the end of the video */
+    loop?: boolean;
+    /** the default setting of the audio contained in the video */
+    muted?: boolean;
+    /** if `true`, the video is to be played "inline", that is within the element's playback area. */
+    playsInline?: boolean;
+    /** prevents the browser from suggesting a Picture-in-Picture context menu */
+    disablePictureInPicture?: boolean;
+    /** disables the capability of remote playback */
+    disableRemotePlayback?: boolean;
     /** an array of video files */
     sources?: {
         /** video source URL */
@@ -23,11 +43,17 @@ declare module "../types.js" {
         /** video slide type */
         SlideVideo: SlideVideo;
     }
+    interface LightboxProps {
+        /** video plugin settings */
+        video?: Pick<SlideVideo, "autoPlay" | "controls" | "controlsList" | "crossOrigin" | "preload" | "loop" | "muted" | "playsInline" | "disablePictureInPicture" | "disableRemotePlayback">;
+    }
 }
-/** Video slide */
-export declare const VideoSlide: ({ slide: { sources, poster, width, height } }: {
+declare type VideoSlideProps = Required<Pick<LightboxProps, "video">> & {
     slide: SlideVideo;
-}) => JSX.Element;
+    offset: number;
+};
+/** Video slide */
+export declare const VideoSlide: React.FC<VideoSlideProps>;
 /** Video plugin */
 export declare const Video: Plugin;
 export default Video;

package/dist/plugins/Video.js

@@ -1,19 +1,53 @@
 import * as React from "react";
 import PropTypes from "prop-types";
 import { SlideTypesPropTypes } from "../types.js";
-import { clsx, cssClass, useContainerRect } from "../core/index.js";
+import { clsx, cssClass, useContainerRect, useLatest } from "../core/index.js";
 SlideTypesPropTypes.push(PropTypes.shape({
     type: PropTypes.oneOf(["video"]).isRequired,
     poster: PropTypes.string,
     width: PropTypes.number,
     height: PropTypes.number,
+    autoPlay: PropTypes.bool,
+    controls: PropTypes.bool,
+    controlsList: PropTypes.string,
+    crossOrigin: PropTypes.string,
+    preload: PropTypes.string,
+    loop: PropTypes.bool,
+    muted: PropTypes.bool,
+    playsInline: PropTypes.bool,
+    disablePictureInPicture: PropTypes.bool,
+    disableRemotePlayback: PropTypes.bool,
     sources: PropTypes.arrayOf(PropTypes.shape({
         src: PropTypes.string.isRequired,
         type: PropTypes.string.isRequired,
     }).isRequired),
 }));
-export const VideoSlide = ({ slide: { sources, poster, width, height } }) => {
+export const VideoSlide = ({ slide, video, offset }) => {
     const { setContainerRef, containerRect } = useContainerRect();
+    const videoRef = React.useRef(null);
+    React.useEffect(() => {
+        if (offset !== 0 && videoRef.current && !videoRef.current.paused) {
+            videoRef.current.pause();
+        }
+    }, [offset]);
+    React.useEffect(() => {
+        if (offset === 0 && videoRef.current && (slide.autoPlay || video.autoPlay)) {
+            videoRef.current.play().catch(() => { });
+        }
+    }, [offset, video.autoPlay, slide.autoPlay]);
+    const latestOffset = useLatest(offset);
+    const latestVideoAutoPlay = useLatest(video.autoPlay);
+    const latestSlideAutoPlay = useLatest(slide.autoPlay);
+    const setVideoRef = React.useCallback((el) => {
+        videoRef.current = el;
+        if (el &&
+            latestOffset.current === 0 &&
+            (latestVideoAutoPlay.current || latestSlideAutoPlay.current) &&
+            el.paused) {
+            el.play().catch(() => { });
+        }
+    }, [latestOffset, latestVideoAutoPlay, latestSlideAutoPlay]);
+    const { width, height, poster, sources } = slide;
     const scaleWidthAndHeight = () => {
         if (!width || !height || !containerRect)
             return null;
@@ -23,24 +57,49 @@ export const VideoSlide = ({ slide: { sources, poster, width, height } }) => {
             height: !widthBound ? containerRect.height : Math.round((containerRect.width / width) * height),
         };
     };
+    const resolveBoolean = (attr) => {
+        if (slide[attr] === false)
+            return null;
+        if (slide[attr] === true)
+            return { [attr]: true };
+        if (video[attr] === false)
+            return null;
+        if (video[attr] === true)
+            return { [attr]: true };
+        return null;
+    };
+    const resolveString = (attr) => {
+        if (video[attr] || slide[attr]) {
+            return { [attr]: slide[attr] || video[attr] };
+        }
+        return null;
+    };
     return (React.createElement(React.Fragment, null, sources && (React.createElement("div", { ref: setContainerRef, style: {
             width: "100%",
             height: "100%",
             ...(width ? { maxWidth: `${width}px` } : null),
-        }, className: clsx(cssClass("video_container"), cssClass("flex_center")) }, containerRect && (React.createElement("video", { controls: true, playsInline: true, poster: poster, ...scaleWidthAndHeight() }, sources.map(({ src, type }, index) => (React.createElement("source", { key: index, src: src, type: type })))))))));
+        }, className: clsx(cssClass("video_container"), cssClass("flex_center")) }, containerRect && (React.createElement("video", { ref: setVideoRef, poster: poster, ...scaleWidthAndHeight(), ...resolveBoolean("controls"), ...resolveBoolean("playsInline"), ...resolveBoolean("loop"), ...resolveBoolean("muted"), ...resolveBoolean("playsInline"), ...resolveBoolean("disablePictureInPicture"), ...resolveBoolean("disableRemotePlayback"), ...resolveString("controlsList"), ...resolveString("crossOrigin"), ...resolveString("preload") }, sources.map(({ src, type }, index) => (React.createElement("source", { key: index, src: src, type: type })))))))));
 };
 export const Video = ({ augment }) => {
-    augment(({ render: { slide: renderSlide, ...restRender }, ...restProps }) => ({
-        render: {
-            slide: (slide, offset, rect) => {
-                if ("type" in slide && slide.type === "video") {
-                    return React.createElement(VideoSlide, { slide: slide });
-                }
-                return renderSlide === null || renderSlide === void 0 ? void 0 : renderSlide(slide, offset, rect);
+    augment(({ render: { slide: renderSlide, ...restRender }, video: originalVideo, ...restProps }) => {
+        const video = {
+            controls: true,
+            playsInline: true,
+            ...originalVideo,
+        };
+        return {
+            render: {
+                slide: (slide, offset, rect) => {
+                    if ("type" in slide && slide.type === "video") {
+                        return React.createElement(VideoSlide, { slide: slide, video: video, offset: offset });
+                    }
+                    return renderSlide === null || renderSlide === void 0 ? void 0 : renderSlide(slide, offset, rect);
+                },
+                ...restRender,
             },
-            ...restRender,
-        },
-        ...restProps,
-    }));
+            video,
+            ...restProps,
+        };
+    });
 };
 export default Video;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "yet-another-react-lightbox",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "description": "Modern React lightbox component",
     "author": "Igor Danchenko",
     "license": "MIT",