yet-another-react-lightbox 3.11.3 → 3.12.0

package/README.md

@@ -6,19 +6,19 @@ Modern React lightbox component. Performant, easy to use, customizable and exten
 
 [![NPM Version](https://img.shields.io/npm/v/yet-another-react-lightbox?color=blue)](https://www.npmjs.com/package/yet-another-react-lightbox)
 [![Bundle Size](https://img.shields.io/bundlephobia/minzip/yet-another-react-lightbox?color=blue)](https://bundlephobia.com/package/yet-another-react-lightbox)
-[![License MIT](https://img.shields.io/npm/l/yet-another-react-lightbox?color=blue)](LICENSE)
-
-- **Built for React:** works with React 18, 17 and 16.8.0+
-- **UX:** supports keyboard, mouse, touchpad and touchscreen navigation
-- **Preloading:** never displays partially downloaded images
-- **Performance:** preloads limited number of images without compromising performance or UX
-- **Responsive:** responsive images with automatic resolution switching are supported out of the box
-- **Video:** video slides are supported via an optional plugin
-- **Zoom:** image zoom is supported via an optional plugin
-- **Customization:** customize any UI element or add your own custom slides
-- **No bloat:** never bundle rarely used features; add optional features via plugins
-- **TypeScript:** type definitions come built-in in the package
-- **RTL:** compatible with RTL layout
+[![License MIT](https://img.shields.io/npm/l/yet-another-react-lightbox?color=blue)](https://github.com/igordanchenko/yet-another-react-lightbox/blob/main/LICENSE)
+
+-   **Built for React:** works with React 18, 17 and 16.8.0+
+-   **UX:** supports keyboard, mouse, touchpad and touchscreen navigation
+-   **Preloading:** never displays partially downloaded images
+-   **Performance:** preloads limited number of images without compromising performance or UX
+-   **Responsive:** responsive images with automatic resolution switching are supported out of the box
+-   **Video:** video slides are supported via an optional plugin
+-   **Zoom:** image zoom is supported via an optional plugin
+-   **Customization:** customize any UI element or add your own custom slides
+-   **No bloat:** never bundle rarely used features; add optional features via plugins
+-   **TypeScript:** type definitions come built-in in the package
+-   **RTL:** compatible with RTL layout
 
 ![Yet Another React Lightbox | Example](https://yet-another-react-lightbox.com/images/example.jpg)
 
@@ -50,25 +50,21 @@ import Lightbox from "yet-another-react-lightbox";
 import "yet-another-react-lightbox/styles.css";
 
 export default function App() {
-  const [open, setOpen] = React.useState(false);
-
-  return (
-    <>
-      <button type="button" onClick={() => setOpen(true)}>
-        Open Lightbox
-      </button>
-
-      <Lightbox
-        open={open}
-        close={() => setOpen(false)}
-        slides={[
-          { src: "/image1.jpg" },
-          { src: "/image2.jpg" },
-          { src: "/image3.jpg" },
-        ]}
-      />
-    </>
-  );
+    const [open, setOpen] = React.useState(false);
+
+    return (
+        <>
+            <button type="button" onClick={() => setOpen(true)}>
+                Open Lightbox
+            </button>
+
+            <Lightbox
+                open={open}
+                close={() => setOpen(false)}
+                slides={[{ src: "/image1.jpg" }, { src: "/image2.jpg" }, { src: "/image3.jpg" }]}
+            />
+        </>
+    );
 }
 ```
 
@@ -85,36 +81,36 @@ import Lightbox from "yet-another-react-lightbox";
 import "yet-another-react-lightbox/styles.css";
 
 export default function App() {
-  const [open, setOpen] = React.useState(false);
-
-  return (
-    <>
-      <button type="button" onClick={() => setOpen(true)}>
-        Open Lightbox
-      </button>
-
-      <Lightbox
-        open={open}
-        close={() => setOpen(false)}
-        slides={[
-          {
-            src: "/image1x3840.jpg",
-            alt: "image 1",
-            width: 3840,
-            height: 2560,
-            srcSet: [
-              { src: "/image1x320.jpg", width: 320, height: 213 },
-              { src: "/image1x640.jpg", width: 640, height: 427 },
-              { src: "/image1x1200.jpg", width: 1200, height: 800 },
-              { src: "/image1x2048.jpg", width: 2048, height: 1365 },
-              { src: "/image1x3840.jpg", width: 3840, height: 2560 },
-            ]
-          },
-          // ...
-        ]}
-      />
-    </>
-  );
+    const [open, setOpen] = React.useState(false);
+
+    return (
+        <>
+            <button type="button" onClick={() => setOpen(true)}>
+                Open Lightbox
+            </button>
+
+            <Lightbox
+                open={open}
+                close={() => setOpen(false)}
+                slides={[
+                    {
+                        src: "/image1x3840.jpg",
+                        alt: "image 1",
+                        width: 3840,
+                        height: 2560,
+                        srcSet: [
+                            { src: "/image1x320.jpg", width: 320, height: 213 },
+                            { src: "/image1x640.jpg", width: 640, height: 427 },
+                            { src: "/image1x1200.jpg", width: 1200, height: 800 },
+                            { src: "/image1x2048.jpg", width: 2048, height: 1365 },
+                            { src: "/image1x3840.jpg", width: 3840, height: 2560 },
+                        ],
+                    },
+                    // ...
+                ]}
+            />
+        </>
+    );
 }
 ```
 
@@ -127,17 +123,17 @@ Yet Another React Lightbox allows you to add optional features to your project b
 
 The following plugins are bundled in the package:
 
-- [Captions](https://yet-another-react-lightbox.com/plugins/captions) - adds support for slide title and
-  description
-- [Counter](https://yet-another-react-lightbox.com/plugins/counter) - adds slides counter
-- [Download](https://yet-another-react-lightbox.com/plugins/download) - adds download button
-- [Fullscreen](https://yet-another-react-lightbox.com/plugins/fullscreen) - adds support for fullscreen mode
-- [Inline](https://yet-another-react-lightbox.com/plugins/inline) - transforms the lightbox into an image carousel
-- [Share](https://yet-another-react-lightbox.com/plugins/share) - adds sharing button
-- [Slideshow](https://yet-another-react-lightbox.com/plugins/slideshow) - adds slideshow button
-- [Thumbnails](https://yet-another-react-lightbox.com/plugins/thumbnails) - adds thumbnails track
-- [Video](https://yet-another-react-lightbox.com/plugins/video) - adds support for video slides
-- [Zoom](https://yet-another-react-lightbox.com/plugins/zoom) - adds image zoom feature
+-   [Captions](https://yet-another-react-lightbox.com/plugins/captions) - adds support for slide title and
+    description
+-   [Counter](https://yet-another-react-lightbox.com/plugins/counter) - adds slides counter
+-   [Download](https://yet-another-react-lightbox.com/plugins/download) - adds download button
+-   [Fullscreen](https://yet-another-react-lightbox.com/plugins/fullscreen) - adds support for fullscreen mode
+-   [Inline](https://yet-another-react-lightbox.com/plugins/inline) - transforms the lightbox into an image carousel
+-   [Share](https://yet-another-react-lightbox.com/plugins/share) - adds sharing button
+-   [Slideshow](https://yet-another-react-lightbox.com/plugins/slideshow) - adds slideshow button
+-   [Thumbnails](https://yet-another-react-lightbox.com/plugins/thumbnails) - adds thumbnails track
+-   [Video](https://yet-another-react-lightbox.com/plugins/video) - adds support for video slides
+-   [Zoom](https://yet-another-react-lightbox.com/plugins/zoom) - adds image zoom feature
 
 ## License
 

package/dist/index.d.ts

@@ -234,9 +234,10 @@ type NavigationButtonProps = {
     action: "prev" | "next";
     onClick: () => void;
     disabled?: boolean;
+    style?: React.CSSProperties;
 };
-declare function NavigationButton({ label, icon, renderIcon, action, onClick, disabled }: NavigationButtonProps): React.JSX.Element;
-declare function Navigation({ carousel: { finite }, animation, render: { buttonPrev, buttonNext, iconPrev, iconNext }, }: ComponentProps): React.JSX.Element;
+declare function NavigationButton({ label, icon, renderIcon, action, onClick, disabled, style }: NavigationButtonProps): React.JSX.Element;
+declare function Navigation({ carousel: { finite }, animation, render: { buttonPrev, buttonNext, iconPrev, iconNext }, styles, }: ComponentProps): React.JSX.Element;
 declare const NavigationModule: Module;
 
 declare function NoScroll({ children }: ComponentProps): React.JSX.Element;
@@ -248,7 +249,7 @@ declare const PortalModule: Module;
 declare function Root({ children }: ComponentProps): React.JSX.Element;
 declare const RootModule: Module;
 
-declare function Toolbar({ toolbar: { buttons }, render: { buttonClose, iconClose } }: ComponentProps): React.JSX.Element;
+declare function Toolbar({ toolbar: { buttons }, render: { buttonClose, iconClose }, styles }: ComponentProps): React.JSX.Element;
 declare const ToolbarModule: Module;
 
 export { Augmentation, Callback, Carousel, CarouselModule, CarouselSettings, CloseIcon, Component, ComponentProps, ComputeAnimation, ContainerRect, Controller, ControllerContext, ControllerContextType, ControllerModule, ControllerRef, ErrorIcon, Event, EventCallback, EventTypes, EventsContext, EventsContextType, EventsProvider, IconButton, IconButtonProps, ImageSlide, ImageSlideProps, KeyboardEventType, Labels, LengthOrPercentage, Lightbox, LightboxDefaultProps, LightboxDispatchContext, LightboxDispatchContextType, LightboxExternalProps, LightboxProps, LightboxPropsContext, LightboxPropsContextType, LightboxPropsProvider, LightboxState, LightboxStateAction, LightboxStateContext, LightboxStateContextType, LightboxStateProvider, LightboxStateProviderProps, LightboxStateSwipeAction, LightboxStateUpdateAction, LoadingIcon, Module, Navigation, NavigationButton, NavigationButtonProps, NavigationModule, NextIcon, NoScroll, NoScrollModule, Node, Plugin, PointerEventType, Portal, PortalModule, PreviousIcon, Publish, ReactEventType, RegisterSensors, Render, RenderFunction, Root, RootModule, SensorCallback, Slide, SlideImage, Subscribe, SubscribeSensors, SupportedEventType, SwipeState, TimeoutsContext, TimeoutsContextType, TimeoutsProvider, Toolbar, ToolbarModule, ToolbarSettings, Topic, Unsubscribe, UseSensors, WheelEventType, addToolbarButton, cleanup, clsx, composePrefix, computeSlideRect, createIcon, createIconDisabled, createModule, createNode, cssClass, cssVar, Lightbox as default, devicePixelRatio, getSlide, getSlideIfPresent, getSlideIndex, hasSlides, hasWindow, isImageFitCover, isImageSlide, label, makeComposePrefix, makeUseContext, parseLengthPercentage, round, setRef, stopNavigationEventsPropagation, useAnimation, useContainerRect, useController, useDelay, useEventCallback, useEvents, useForkRef, useLayoutEffect, useLightboxDispatch, useLightboxProps, useLightboxState, useLoseFocus, useMotionPreference, usePointerSwipe, usePreventSwipeNavigation, useRTL, useSensors, useThrottle, useTimeouts, useWheelSwipe, withPlugins };

package/dist/index.js

@@ -1201,10 +1201,10 @@ function Carousel({ carousel: { finite, preload, padding, spacing } }) {
 }
 const CarouselModule = createModule(MODULE_CAROUSEL, Carousel);
 
-function NavigationButton({ label, icon, renderIcon, action, onClick, disabled }) {
-    return (React.createElement(IconButton, { label: label, icon: icon, renderIcon: renderIcon, className: cssClass(`navigation_${action}`), disabled: disabled, onClick: onClick, ...useLoseFocus(useController().focus, disabled) }));
+function NavigationButton({ label, icon, renderIcon, action, onClick, disabled, style }) {
+    return (React.createElement(IconButton, { label: label, icon: icon, renderIcon: renderIcon, className: cssClass(`navigation_${action}`), disabled: disabled, onClick: onClick, style: style, ...useLoseFocus(useController().focus, disabled) }));
 }
-function Navigation({ carousel: { finite }, animation, render: { buttonPrev, buttonNext, iconPrev, iconNext }, }) {
+function Navigation({ carousel: { finite }, animation, render: { buttonPrev, buttonNext, iconPrev, iconNext }, styles, }) {
     var _a;
     const { slides, currentIndex } = useLightboxState();
     const { prev, next, subscribeSensors } = useController();
@@ -1224,8 +1224,8 @@ function Navigation({ carousel: { finite }, animation, render: { buttonPrev, but
     });
     React.useEffect(() => subscribeSensors(EVENT_ON_KEY_DOWN, handleKeyDown), [subscribeSensors, handleKeyDown]);
     return (React.createElement(React.Fragment, null,
-        buttonPrev ? (buttonPrev()) : (React.createElement(NavigationButton, { label: "Previous", action: ACTION_PREV, icon: PreviousIcon, renderIcon: iconPrev, disabled: prevDisabled, onClick: prev })),
-        buttonNext ? (buttonNext()) : (React.createElement(NavigationButton, { label: "Next", action: ACTION_NEXT, icon: NextIcon, renderIcon: iconNext, disabled: nextDisabled, onClick: next }))));
+        buttonPrev ? (buttonPrev()) : (React.createElement(NavigationButton, { label: "Previous", action: ACTION_PREV, icon: PreviousIcon, renderIcon: iconPrev, style: styles.navigationPrev, disabled: prevDisabled, onClick: prev })),
+        buttonNext ? (buttonNext()) : (React.createElement(NavigationButton, { label: "Next", action: ACTION_NEXT, icon: NextIcon, renderIcon: iconNext, style: styles.navigationNext, disabled: nextDisabled, onClick: next }))));
 }
 const NavigationModule = createModule(MODULE_NAVIGATION, Navigation);
 
@@ -1370,7 +1370,7 @@ const RootModule = createModule(MODULE_ROOT, Root);
 function cssPrefix(value) {
     return composePrefix(MODULE_TOOLBAR, value);
 }
-function Toolbar({ toolbar: { buttons }, render: { buttonClose, iconClose } }) {
+function Toolbar({ toolbar: { buttons }, render: { buttonClose, iconClose }, styles }) {
     const { close, setToolbarWidth } = useController();
     const { setContainerRef, containerRect } = useContainerRect();
     useLayoutEffect(() => {
@@ -1381,7 +1381,7 @@ function Toolbar({ toolbar: { buttons }, render: { buttonClose, iconClose } }) {
             return buttonClose();
         return React.createElement(IconButton, { key: ACTION_CLOSE, label: "Close", icon: CloseIcon, renderIcon: iconClose, onClick: close });
     };
-    return (React.createElement("div", { ref: setContainerRef, className: cssClass(cssPrefix()), ...stopNavigationEventsPropagation() }, buttons === null || buttons === void 0 ? void 0 : buttons.map((button) => (button === ACTION_CLOSE ? renderCloseButton() : button))));
+    return (React.createElement("div", { ref: setContainerRef, style: styles.toolbar, className: cssClass(cssPrefix()), ...stopNavigationEventsPropagation() }, buttons === null || buttons === void 0 ? void 0 : buttons.map((button) => (button === ACTION_CLOSE ? renderCloseButton() : button))));
 }
 const ToolbarModule = createModule(MODULE_TOOLBAR, Toolbar);
 

package/dist/plugins/inline/index.js

@@ -2,8 +2,8 @@ import { clsx, cssClass, createModule } from '../../index.js';
 import * as React from 'react';
 import { ACTION_CLOSE, MODULE_NO_SCROLL, MODULE_PORTAL, PLUGIN_INLINE } from '../../types.js';
 
-function InlineContainer({ inline: { className, ...rest } = {}, children }) {
-    return (React.createElement("div", { className: clsx(cssClass("root"), cssClass("relative"), className), ...rest }, children));
+function InlineContainer({ inline: { className, style, ...rest } = {}, styles, children }) {
+    return (React.createElement("div", { className: clsx(cssClass("root"), cssClass("relative"), className), style: { ...styles.root, ...style }, ...rest }, children));
 }
 
 function Inline({ augment, replace, remove }) {

package/dist/plugins/video/index.js

@@ -96,7 +96,7 @@ function Video({ augment }) {
             slide: ({ slide, offset, rect }) => {
                 var _a;
                 if (isVideoSlide(slide)) {
-                    return (React.createElement(VideoSlide, { key: `${(_a = slide.sources) === null || _a === void 0 ? void 0 : _a.map((source) => source.src).join(" ")}`, slide: slide, offset: offset }));
+                    return (React.createElement(VideoSlide, { key: (_a = slide.sources) === null || _a === void 0 ? void 0 : _a.map((source) => source.src).join(" "), slide: slide, offset: offset }));
                 }
                 return renderSlide === null || renderSlide === void 0 ? void 0 : renderSlide({ slide, offset, rect });
             },

package/dist/types.d.ts

@@ -167,6 +167,12 @@ interface SlotType {
     button: "button";
     /** lightbox icon customization slot */
     icon: "icon";
+    /** lightbox toolbar customization slot */
+    toolbar: "toolbar";
+    /** lightbox Prev navigation button customization slot */
+    navigationPrev: "navigationPrev";
+    /** lightbox Next navigation button customization slot */
+    navigationNext: "navigationNext";
 }
 /** Customization slot CSS properties */
 interface SlotCSSProperties extends React.CSSProperties {

package/package.json

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