yet-another-react-lightbox 3.3.0 → 3.4.0

package/dist/core/consts.d.ts

@@ -7,6 +7,7 @@ export declare const MODULE_ROOT = "root";
 export declare const MODULE_TOOLBAR = "toolbar";
 export declare const PLUGIN_CAPTIONS = "captions";
 export declare const PLUGIN_COUNTER = "counter";
+export declare const PLUGIN_DOWNLOAD = "download";
 export declare const PLUGIN_FULLSCREEN = "fullscreen";
 export declare const PLUGIN_INLINE = "inline";
 export declare const PLUGIN_SLIDESHOW = "slideshow";

package/dist/core/consts.js

@@ -7,6 +7,7 @@ export const MODULE_ROOT = "root";
 export const MODULE_TOOLBAR = "toolbar";
 export const PLUGIN_CAPTIONS = "captions";
 export const PLUGIN_COUNTER = "counter";
+export const PLUGIN_DOWNLOAD = "download";
 export const PLUGIN_FULLSCREEN = "fullscreen";
 export const PLUGIN_INLINE = "inline";
 export const PLUGIN_SLIDESHOW = "slideshow";

package/dist/core/contexts/LightboxState.d.ts

@@ -12,11 +12,16 @@ export type LightboxStateUpdateAction = {
     index: number;
 };
 export type LightboxStateAction = LightboxStateSwipeAction | LightboxStateUpdateAction;
-export type LightboxStateContextType = {
+export type LightboxStateContextType = LightboxState & {
+    /** @deprecated - use `useLightboxState` props directly */
     state: LightboxState;
+    /** @deprecated - use `useLightboxDispatch` instead */
     dispatch: React.Dispatch<LightboxStateAction>;
 };
 export declare const LightboxStateContext: React.Context<LightboxStateContextType | null>;
-export declare const useLightboxState: () => LightboxStateContextType;
+export declare const useLightboxState: () => NonNullable<LightboxStateContextType>;
+export type LightboxDispatchContextType = React.Dispatch<LightboxStateAction>;
+export declare const LightboxDispatchContext: React.Context<LightboxDispatchContextType | null>;
+export declare const useLightboxDispatch: () => LightboxDispatchContextType;
 export type LightboxStateProviderProps = React.PropsWithChildren<Pick<LightboxProps, "slides" | "index">>;
 export declare function LightboxStateProvider({ slides, index, children }: LightboxStateProviderProps): JSX.Element;

package/dist/core/contexts/LightboxState.js

@@ -1,8 +1,10 @@
 import * as React from "react";
-import { getSlideIndex, makeUseContext } from "../utils.js";
+import { getSlideIfPresent, getSlideIndex, makeUseContext } from "../utils.js";
 import { UNKNOWN_ACTION_TYPE } from "../consts.js";
 export const LightboxStateContext = React.createContext(null);
 export const useLightboxState = makeUseContext("useLightboxState", "LightboxStateContext", LightboxStateContext);
+export const LightboxDispatchContext = React.createContext(null);
+export const useLightboxDispatch = makeUseContext("useLightboxDispatch", "LightboxDispatchContext", LightboxDispatchContext);
 function reducer(state, action) {
     switch (action.type) {
         case "swipe": {
@@ -10,6 +12,7 @@ function reducer(state, action) {
             const increment = (action === null || action === void 0 ? void 0 : action.increment) || 0;
             const globalIndex = state.globalIndex + increment;
             const currentIndex = getSlideIndex(globalIndex, slides.length);
+            const currentSlide = getSlideIfPresent(slides, currentIndex);
             const animation = increment || action.duration
                 ? {
                     increment,
@@ -17,23 +20,30 @@ function reducer(state, action) {
                     easing: action.easing,
                 }
                 : undefined;
-            return { slides, currentIndex, globalIndex, animation };
+            return { slides, currentIndex, globalIndex, currentSlide, animation };
         }
         case "update":
             return {
                 slides: action.slides,
                 currentIndex: action.index,
                 globalIndex: action.index,
+                currentSlide: getSlideIfPresent(action.slides, action.index),
             };
         default:
             throw new Error(UNKNOWN_ACTION_TYPE);
     }
 }
 export function LightboxStateProvider({ slides, index, children }) {
-    const [state, dispatch] = React.useReducer(reducer, { slides, currentIndex: index, globalIndex: index });
+    const [state, dispatch] = React.useReducer(reducer, {
+        slides,
+        currentIndex: index,
+        globalIndex: index,
+        currentSlide: getSlideIfPresent(slides, index),
+    });
     React.useEffect(() => {
         dispatch({ type: "update", slides, index });
     }, [slides, index]);
-    const context = React.useMemo(() => ({ state, dispatch }), [state, dispatch]);
-    return React.createElement(LightboxStateContext.Provider, { value: context }, children);
+    const context = React.useMemo(() => ({ ...state, state, dispatch }), [state, dispatch]);
+    return (React.createElement(LightboxDispatchContext.Provider, { value: dispatch },
+        React.createElement(LightboxStateContext.Provider, { value: context }, children)));
 }

package/dist/core/modules/Carousel.js

@@ -13,7 +13,7 @@ function cssSlidePrefix(value) {
 }
 function CarouselSlide({ slide, offset }) {
     const containerRef = React.useRef(null);
-    const { currentIndex } = useLightboxState().state;
+    const { currentIndex } = useLightboxState();
     const { slideRect, close } = useController();
     const { render, carousel: { imageFit }, on: { click: onClick }, controller: { closeOnBackdropClick }, } = useLightboxProps();
     const renderSlide = () => {
@@ -45,7 +45,7 @@ function Placeholder() {
     return React.createElement("div", { className: cssClass("slide") });
 }
 export function Carousel({ carousel: { finite, preload, padding, spacing } }) {
-    const { slides, currentIndex, globalIndex } = useLightboxState().state;
+    const { slides, currentIndex, globalIndex } = useLightboxState();
     const { setCarouselRef } = useController();
     const spacingValue = parseLengthPercentage(spacing);
     const paddingValue = parseLengthPercentage(padding);

package/dist/core/modules/Controller.js

@@ -2,7 +2,7 @@ import * as React from "react";
 import { createModule } from "../config.js";
 import { cleanup, clsx, computeSlideRect, cssClass, cssVar, makeComposePrefix, makeUseContext, parseLengthPercentage, } from "../utils.js";
 import { useAnimation, useContainerRect, useDelay, useEventCallback, useForkRef, useRTL, useSensors, } from "../hooks/index.js";
-import { useEvents, useLightboxState } from "../contexts/index.js";
+import { useEvents, useLightboxDispatch, useLightboxState } from "../contexts/index.js";
 import { SwipeState, usePointerSwipe, usePreventSwipeNavigation, useWheelSwipe } from "./controller/index.js";
 import { ACTION_CLOSE, ACTION_NEXT, ACTION_PREV, ACTION_SWIPE, ACTIVE_SLIDE_COMPLETE, ACTIVE_SLIDE_ERROR, ACTIVE_SLIDE_LOADING, ACTIVE_SLIDE_PLAYING, CLASS_FLEX_CENTER, EVENT_ON_KEY_UP, MODULE_CONTROLLER, VK_ESCAPE, } from "../consts.js";
 const cssContainerPrefix = makeComposePrefix("container");
@@ -12,7 +12,8 @@ export function Controller({ children, ...props }) {
     var _a;
     const { carousel, animation, controller, on, styles, render } = props;
     const [toolbarWidth, setToolbarWidth] = React.useState();
-    const { state, dispatch } = useLightboxState();
+    const { state } = useLightboxState();
+    const dispatch = useLightboxDispatch();
     const [swipeState, setSwipeState] = React.useState(SwipeState.NONE);
     const swipeOffset = React.useRef(0);
     const { registerSensors, subscribeSensors } = useSensors();

package/dist/core/modules/Navigation.js

@@ -11,7 +11,7 @@ export function NavigationButton({ label, icon, renderIcon, action, onClick, dis
 }
 export function Navigation({ carousel: { finite }, animation, render: { buttonPrev, buttonNext, iconPrev, iconNext }, }) {
     var _a;
-    const { slides, currentIndex } = useLightboxState().state;
+    const { slides, currentIndex } = useLightboxState();
     const { prev, next, subscribeSensors } = useController();
     const isRTL = useRTL();
     const prevDisabled = slides.length === 0 || (finite && currentIndex === 0);

package/dist/core/utils.d.ts

@@ -25,5 +25,7 @@ export declare function computeSlideRect(containerRect: ContainerRect, padding:
 };
 export declare const devicePixelRatio: () => number;
 export declare const getSlideIndex: (index: number, slidesCount: number) => number;
-export declare const getSlide: (slides: Slide[], index: number) => Slide;
+export declare const hasSlides: (slides: Slide[]) => slides is [Slide, ...Slide[]];
+export declare const getSlide: (slides: [Slide, ...Slide[]], index: number) => Slide;
+export declare const getSlideIfPresent: (slides: Slide[], index: number) => Slide | undefined;
 export declare function addToolbarButton(toolbar: ToolbarSettings, key: string, button: React.ReactNode): ToolbarSettings;

package/dist/core/utils.js

@@ -45,8 +45,10 @@ export function computeSlideRect(containerRect, padding) {
     };
 }
 export const devicePixelRatio = () => (hasWindow() ? window === null || window === void 0 ? void 0 : window.devicePixelRatio : undefined) || 1;
-export const getSlideIndex = (index, slidesCount) => ((index % slidesCount) + slidesCount) % slidesCount;
+export const getSlideIndex = (index, slidesCount) => slidesCount > 0 ? ((index % slidesCount) + slidesCount) % slidesCount : 0;
+export const hasSlides = (slides) => slides.length > 0;
 export const getSlide = (slides, index) => slides[getSlideIndex(index, slides.length)];
+export const getSlideIfPresent = (slides, index) => hasSlides(slides) ? getSlide(slides, index) : undefined;
 export function addToolbarButton(toolbar, key, button) {
     if (!button)
         return toolbar;

package/dist/plugins/counter/Counter.js

@@ -1,7 +1,7 @@
 import * as React from "react";
 import { clsx, createModule, cssClass, MODULE_CONTROLLER, PLUGIN_COUNTER, useLightboxState } from "../../core/index.js";
 export function CounterComponent({ counter: { className, ...rest } = {} }) {
-    const { slides, currentIndex } = useLightboxState().state;
+    const { slides, currentIndex } = useLightboxState();
     if (slides.length === 0)
         return null;
     return (React.createElement("div", { className: clsx(cssClass("counter"), className), ...rest },

package/dist/plugins/download/Download.d.ts

@@ -0,0 +1,2 @@
+import { PluginProps } from "../../types.js";
+export declare function Download({ augment }: PluginProps): void;

package/dist/plugins/download/Download.js

@@ -0,0 +1,9 @@
+import * as React from "react";
+import { addToolbarButton, PLUGIN_DOWNLOAD } from "../../core/index.js";
+import { DownloadButton } from "./DownloadButton.js";
+export function Download({ augment }) {
+    augment(({ toolbar, ...restProps }) => ({
+        toolbar: addToolbarButton(toolbar, PLUGIN_DOWNLOAD, React.createElement(DownloadButton, null)),
+        ...restProps,
+    }));
+}

package/dist/plugins/download/DownloadButton.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function DownloadButton(): JSX.Element;

package/dist/plugins/download/DownloadButton.js

@@ -0,0 +1,17 @@
+import * as React from "react";
+import { createIcon, IconButton, isImageSlide, useLightboxProps, useLightboxState } from "../../core/index.js";
+import { saveAs } from "./FileSaver.js";
+const DownloadIcon = createIcon("DownloadIcon", React.createElement("path", { d: "M18 15v3H6v-3H4v3c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2v-3h-2zm-1-4-1.41-1.41L13 12.17V4h-2v8.17L8.41 9.59 7 11l5 5 5-5z" }));
+export function DownloadButton() {
+    const { render } = useLightboxProps();
+    const { currentSlide } = useLightboxState();
+    if (render.buttonDownload) {
+        return React.createElement(React.Fragment, null, render.buttonDownload());
+    }
+    const downloadUrl = (currentSlide === null || currentSlide === void 0 ? void 0 : currentSlide.downloadUrl) || (currentSlide && isImageSlide(currentSlide) ? currentSlide.src : undefined);
+    return (React.createElement(IconButton, { label: "Download", icon: DownloadIcon, renderIcon: render.iconDownload, disabled: !downloadUrl, onClick: () => {
+            if (downloadUrl) {
+                saveAs(downloadUrl, currentSlide === null || currentSlide === void 0 ? void 0 : currentSlide.downloadFilename);
+            }
+        } }));
+}

package/dist/plugins/download/FileSaver.d.ts

@@ -0,0 +1 @@
+export declare function saveAs(source: string | Blob, name?: string): void;

package/dist/plugins/download/FileSaver.js

@@ -0,0 +1,60 @@
+function download(url, name) {
+    const xhr = new XMLHttpRequest();
+    xhr.open("GET", url);
+    xhr.responseType = "blob";
+    xhr.onload = () => {
+        saveAs(xhr.response, name);
+    };
+    xhr.onerror = () => {
+        console.error("Failed to download file");
+    };
+    xhr.send();
+}
+function corsEnabled(url) {
+    const xhr = new XMLHttpRequest();
+    xhr.open("HEAD", url, false);
+    try {
+        xhr.send();
+    }
+    catch (e) {
+    }
+    return xhr.status >= 200 && xhr.status <= 299;
+}
+function click(link) {
+    try {
+        link.dispatchEvent(new MouseEvent("click"));
+    }
+    catch (e) {
+        const event = document.createEvent("MouseEvents");
+        event.initMouseEvent("click", true, true, window, 0, 0, 0, 80, 20, false, false, false, false, 0, null);
+        link.dispatchEvent(event);
+    }
+}
+export function saveAs(source, name) {
+    const link = document.createElement("a");
+    link.rel = "noopener";
+    link.download = name || "";
+    if (!link.download) {
+        link.target = "_blank";
+    }
+    if (typeof source === "string") {
+        link.href = source;
+        if (link.origin !== window.location.origin) {
+            if (corsEnabled(link.href)) {
+                download(source, name);
+            }
+            else {
+                link.target = "_blank";
+                click(link);
+            }
+        }
+        else {
+            click(link);
+        }
+    }
+    else {
+        link.href = URL.createObjectURL(source);
+        setTimeout(() => URL.revokeObjectURL(link.href), 30000);
+        setTimeout(() => click(link), 0);
+    }
+}

package/dist/plugins/download/index.d.ts

@@ -0,0 +1,20 @@
+import { PLUGIN_DOWNLOAD } from "../../core/index.js";
+import { Download } from "./Download.js";
+declare module "../../types.js" {
+    interface GenericSlide {
+        /** download url */
+        downloadUrl?: string;
+        /** download filename override */
+        downloadFilename?: string;
+    }
+    interface Render {
+        /** render custom Download button */
+        buttonDownload?: RenderFunction;
+        /** render custom Download icon */
+        iconDownload?: RenderFunction;
+    }
+    interface ToolbarButtonKeys {
+        [PLUGIN_DOWNLOAD]: null;
+    }
+}
+export default Download;

package/dist/plugins/download/index.js

@@ -0,0 +1,3 @@
+import { PLUGIN_DOWNLOAD } from "../../core/index.js";
+import { Download } from "./Download.js";
+export default Download;

package/dist/plugins/index.d.ts

@@ -1,5 +1,6 @@
 export { default as Captions } from "./captions/index.js";
 export { default as Counter } from "./counter/index.js";
+export { default as Download } from "./download/index.js";
 export { default as Fullscreen } from "./fullscreen/index.js";
 export { default as Inline } from "./inline/index.js";
 export { default as Slideshow } from "./slideshow/index.js";

package/dist/plugins/index.js

@@ -1,5 +1,6 @@
 export { default as Captions } from "./captions/index.js";
 export { default as Counter } from "./counter/index.js";
+export { default as Download } from "./download/index.js";
 export { default as Fullscreen } from "./fullscreen/index.js";
 export { default as Inline } from "./inline/index.js";
 export { default as Slideshow } from "./slideshow/index.js";

package/dist/plugins/slideshow/SlideshowContext.js

@@ -8,7 +8,7 @@ export function SlideshowContextProvider({ slideshow, carousel: { finite }, chil
     const [playing, setPlaying] = React.useState(autoplay);
     const scheduler = React.useRef();
     const slideStatus = React.useRef();
-    const { slides, currentIndex } = useLightboxState().state;
+    const { slides, currentIndex } = useLightboxState();
     const { setTimeout, clearTimeout } = useTimeouts();
     const { subscribe } = useEvents();
     const { next } = useController();

package/dist/plugins/thumbnails/ThumbnailsTrack.js

@@ -1,5 +1,5 @@
 import * as React from "react";
-import { ACTION_NEXT, ACTION_PREV, ACTION_SWIPE, CLASS_FLEX_CENTER, cleanup, clsx, cssClass, cssVar, getSlide, useAnimation, useEventCallback, useEvents, useLightboxProps, useLightboxState, useRTL, } from "../../core/index.js";
+import { ACTION_NEXT, ACTION_PREV, ACTION_SWIPE, CLASS_FLEX_CENTER, cleanup, clsx, cssClass, cssVar, getSlide, hasSlides, useAnimation, useEventCallback, useEvents, useLightboxProps, useLightboxState, useRTL, } from "../../core/index.js";
 import { cssPrefix, cssThumbnailPrefix } from "./utils.js";
 import { Thumbnail } from "./Thumbnail.js";
 import { defaultThumbnailsProps, useThumbnailsProps } from "./props.js";
@@ -14,7 +14,7 @@ export function ThumbnailsTrack({ containerRef }) {
     const track = React.useRef(null);
     const { visible } = useThumbnails();
     const { carousel, styles } = useLightboxProps();
-    const { slides, globalIndex, animation } = useLightboxState().state;
+    const { slides, globalIndex, animation } = useLightboxState();
     const { publish, subscribe } = useEvents();
     const isRTL = useRTL();
     const thumbnails = useThumbnailsProps();
@@ -57,7 +57,7 @@ export function ThumbnailsTrack({ containerRef }) {
     const { finite } = carousel;
     const preload = Math.max(Math.min(carousel.preload, slides.length - 1), 0);
     const items = [];
-    if (slides.length > 0) {
+    if (hasSlides(slides)) {
         if (offset < 0) {
             for (let i = index - preload + offset; i < index - preload; i += 1) {
                 items.push({ slide: null, index: i, placeholder: true });

package/dist/plugins/zoom/ZoomWrapper.js

@@ -8,7 +8,7 @@ export function ZoomWrapper({ render, slide, offset, rect }) {
     const zoomWrapperRef = React.useRef(null);
     const { zoom, maxZoom, offsetX, offsetY, setZoomWrapper } = useZoom();
     const { carousel, on } = useLightboxProps();
-    const { currentIndex } = useLightboxState().state;
+    const { currentIndex } = useLightboxState();
     useLayoutEffect(() => {
         if (offset === 0) {
             setZoomWrapper({ zoomWrapperRef, imageDimensions });

package/dist/plugins/zoom/hooks/useZoomImageRect.js

@@ -4,7 +4,7 @@ export function useZoomImageRect(slideRect, imageDimensions) {
     var _a, _b;
     let imageRect = { width: 0, height: 0 };
     let maxImageRect = { width: 0, height: 0 };
-    const { slides, currentIndex } = useLightboxState().state;
+    const { slides, currentIndex } = useLightboxState();
     const { imageFit } = useLightboxProps().carousel;
     const { maxZoomPixelRatio } = useZoomProps();
     if (slideRect && currentIndex < slides.length) {

package/dist/plugins/zoom/hooks/useZoomSensors.js

@@ -8,7 +8,7 @@ export function useZoomSensors(zoom, maxZoom, disabled, changeZoom, changeOffset
     const activePointers = React.useRef([]);
     const lastPointerDown = React.useRef(0);
     const pinchZoomDistance = React.useRef();
-    const { globalIndex } = useLightboxState().state;
+    const { globalIndex } = useLightboxState();
     const { containerRef, subscribeSensors } = useController();
     const { keyboardMoveDistance, zoomInMultiplier, wheelZoomDistanceFactor, scrollToZoom, doubleTapDelay, doubleClickDelay, doubleClickMaxStops, pinchZoomDistanceFactor, } = useZoomProps();
     const translateCoordinates = React.useCallback((event) => {

package/dist/plugins/zoom/hooks/useZoomState.js

@@ -15,7 +15,7 @@ export function useZoomState(imageRect, maxZoom, zoomWrapperRef) {
     const [offsetX, setOffsetX] = React.useState(0);
     const [offsetY, setOffsetY] = React.useState(0);
     const animate = useZoomAnimation(zoom, offsetX, offsetY, zoomWrapperRef);
-    const { slides, currentIndex, globalIndex } = useLightboxState().state;
+    const { slides, currentIndex, globalIndex } = useLightboxState();
     const { containerRect, slideRect } = useController();
     const { zoomInMultiplier } = useZoomProps();
     const currentSource = getCurrentSource(slides, currentIndex);

package/dist/types.d.ts

@@ -190,6 +190,8 @@ export interface LightboxState {
     currentIndex: number;
     /** current slide index in the (-∞, +∞) range */
     globalIndex: number;
+    /** current slide */
+    currentSlide: Slide | undefined;
     /** current animation */
     animation?: {
         increment?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "yet-another-react-lightbox",
-    "version": "3.3.0",
+    "version": "3.4.0",
     "description": "Modern React lightbox component",
     "author": "Igor Danchenko",
     "license": "MIT",
@@ -30,6 +30,10 @@
             "types": "./dist/plugins/counter/index.d.ts",
             "default": "./dist/plugins/counter/index.js"
         },
+        "./plugins/download": {
+            "types": "./dist/plugins/download/index.d.ts",
+            "default": "./dist/plugins/download/index.js"
+        },
         "./plugins/fullscreen": {
             "types": "./dist/plugins/fullscreen/index.d.ts",
             "default": "./dist/plugins/fullscreen/index.js"
@@ -74,6 +78,9 @@
             "plugins/counter": [
                 "dist/plugins/counter/index.d.ts"
             ],
+            "plugins/download": [
+                "dist/plugins/download/index.d.ts"
+            ],
             "plugins/fullscreen": [
                 "dist/plugins/fullscreen/index.d.ts"
             ],