yet-another-react-lightbox 1.2.2 → 1.3.1

package/README.md

@@ -1,6 +1,6 @@
 # Yet Another React Lightbox
 
-Modern lightbox component for React.
+Modern React lightbox component.
 
 ## Overview
 
@@ -8,11 +8,9 @@ Modern lightbox component for React.
 [![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)
 
-Coming soon...
-
 ## Documentation
 
-Coming soon...
+[https://yet-another-react-lightbox.vercel.app/](https://yet-another-react-lightbox.vercel.app/)
 
 ## Installation
 
@@ -30,10 +28,10 @@ yarn add yet-another-react-lightbox
 
 ```javascript
 import * as React from "react";
-import { Lightbox } from "yet-another-react-lightbox";
+import Lightbox from "yet-another-react-lightbox";
 import "yet-another-react-lightbox/styles.css";
 
-const Page = () => {
+const App = () => {
     const [open, setOpen] = React.useState(false);
 
     return (
@@ -55,7 +53,7 @@ const Page = () => {
     );
 };
 
-export default Page;
+export default App;
 ```
 
 ## License

package/dist/Lightbox.d.ts

@@ -1,49 +1,7 @@
-import * as React from "react";
-import { LightboxDefaultProps, LightboxProps } from "./types.js";
-declare const LightboxComponent: {
-    (props: LightboxProps & typeof LightboxDefaultProps): JSX.Element | null;
-    propTypes: {
-        open: import("prop-types").Validator<boolean>;
-        close: import("prop-types").Validator<(...args: any[]) => any>;
-        index: import("prop-types").Validator<number>;
-        slides: import("prop-types").Validator<any[]>;
-        render: import("prop-types").Validator<import("prop-types").InferProps<{}>>;
-        plugins: import("prop-types").Validator<((...args: any[]) => any)[]>;
-        toolbar: import("prop-types").Validator<import("prop-types").InferProps<{
-            buttons: import("prop-types").Validator<(string | number | boolean | import("prop-types").ReactElementLike | import("prop-types").ReactNodeArray | null | undefined)[]>;
-        }>>;
-        labels: import("prop-types").Validator<import("prop-types").InferProps<{}>>;
-        carousel: import("prop-types").Validator<import("prop-types").InferProps<{
-            finite: import("prop-types").Validator<boolean>;
-            preload: import("prop-types").Validator<number>;
-            padding: import("prop-types").Validator<string | number>;
-            spacing: import("prop-types").Validator<string | number>;
-        }>>;
-        animation: import("prop-types").Validator<import("prop-types").InferProps<{
-            fade: import("prop-types").Validator<number>;
-            swipe: import("prop-types").Validator<number>;
-        }>>;
-        on: import("prop-types").Validator<import("prop-types").InferProps<{}>>;
-    };
-    defaultProps: {
-        open: boolean;
-        close: () => void;
-        index: number;
-        slides: import("./types.js").Slide[];
-        render: import("./types.js").Render;
-        plugins: import("./types.js").Plugin[];
-        toolbar: import("./types.js").Toolbar;
-        labels: import("./types.js").Labels;
-        animation: import("./types.js").Animation;
-        carousel: import("./types.js").Carousel;
-        on: import("./types.js").Callbacks;
-    };
+/// <reference types="react" />
+import { LightboxProps } from "./types.js";
+declare type DeepPartial<T, K extends keyof T> = Omit<T, K> & {
+    [P in keyof Pick<T, K>]?: Partial<Pick<T, K>[P]>;
 };
-declare type LightboxComponentProps<T> = T extends React.ComponentType<infer P> | React.Component<infer P> ? JSX.LibraryManagedAttributes<T, P> : never;
-declare type MakePartial<T> = T extends object ? Partial<T> : T;
-declare type NestedPartial<T extends object> = {
-    [P in keyof T]?: MakePartial<T[P]>;
-};
-declare type NestedOptional<T, K extends keyof T> = Omit<T, K> & NestedPartial<Pick<T, K>>;
-export declare const Lightbox: (props: NestedOptional<LightboxComponentProps<typeof LightboxComponent>, "carousel" | "animation">) => JSX.Element;
+export declare const Lightbox: (props: DeepPartial<Partial<LightboxProps>, "carousel" | "animation" | "render" | "toolbar" | "on">) => JSX.Element;
 export {};

package/dist/Lightbox.js

@@ -24,9 +24,8 @@ const LightboxComponent = (props) => {
     return React.createElement(React.Fragment, null, renderNode(createNode(CoreModule, config), augmentedProps));
 };
 LightboxComponent.propTypes = LightboxPropTypes;
-LightboxComponent.defaultProps = LightboxDefaultProps;
 export const Lightbox = (props) => {
-    const { carousel, animation, ...restProps } = props;
-    const { carousel: defaultCarousel, animation: defaultAnimation, ...restDefaultProps } = LightboxDefaultProps;
-    return (React.createElement(LightboxComponent, { carousel: { ...defaultCarousel, ...carousel }, animation: { ...defaultAnimation, ...animation }, ...restDefaultProps, ...restProps }));
+    const { carousel, animation, render, toolbar, on, ...restProps } = props;
+    const { carousel: defaultCarousel, animation: defaultAnimation, render: defaultRender, toolbar: defaultToolbar, on: defaultOn, ...restDefaultProps } = LightboxDefaultProps;
+    return (React.createElement(LightboxComponent, { carousel: { ...defaultCarousel, ...carousel }, animation: { ...defaultAnimation, ...animation }, render: { ...defaultRender, ...render }, toolbar: { ...defaultToolbar, ...toolbar }, on: { ...defaultOn, ...on }, ...restDefaultProps, ...restProps }));
 };

package/dist/index.d.ts

@@ -1,2 +1,4 @@
+import { Lightbox } from "./Lightbox.js";
 export * from "./types.js";
 export * from "./Lightbox.js";
+export default Lightbox;

package/dist/index.js

@@ -1,2 +1,4 @@
+import { Lightbox } from "./Lightbox.js";
 export * from "./types.js";
 export * from "./Lightbox.js";
+export default Lightbox;

package/dist/plugins/Fullscreen.d.ts

@@ -31,9 +31,12 @@ declare global {
         msRequestFullscreen?: () => void;
     }
 }
-export declare type FullscreenButtonProps = Pick<LightboxProps, "labels"> & {
+declare type FullscreenButtonProps = Pick<LightboxProps, "labels"> & {
     auto: boolean;
     render: Render;
 };
-export declare const FullscreenButton: ({ auto, labels, render }: FullscreenButtonProps) => JSX.Element | null;
-export declare const Fullscreen: Plugin;
+declare const FullscreenButton: ({ auto, labels, render }: FullscreenButtonProps) => JSX.Element | null;
+declare const Fullscreen: Plugin;
+export type { FullscreenButtonProps };
+export { Fullscreen, FullscreenButton };
+export default Fullscreen;

package/dist/plugins/Fullscreen.js

@@ -2,7 +2,7 @@ import * as React from "react";
 import { createIcon, IconButton, label, useController, useLatest } from "../core/index.js";
 const EnterFullscreenIcon = createIcon("EnterFullscreen", React.createElement("path", { d: "M7 14H5v5h5v-2H7v-3zm-2-4h2V7h3V5H5v5zm12 7h-3v2h5v-5h-2v3zM14 5v2h3v3h2V5h-5z" }));
 const ExitFullscreenIcon = createIcon("ExitFullscreen", React.createElement("path", { d: "M5 16h3v3h2v-5H5v2zm3-8H5v2h5V5H8v3zm6 11h2v-3h3v-2h-5v5zm2-11V5h-2v5h5V8h-3z" }));
-export const FullscreenButton = ({ auto, labels, render }) => {
+const FullscreenButton = ({ auto, labels, render }) => {
     const [fullscreen, setFullscreen] = React.useState(false);
     const latestAuto = useLatest(auto);
     const { containerRef } = useController();
@@ -92,7 +92,7 @@ export const FullscreenButton = ({ auto, labels, render }) => {
         return null;
     return render.buttonFullscreen ? (React.createElement(React.Fragment, null, render.buttonFullscreen({ fullscreen, toggleFullscreen }))) : (React.createElement(IconButton, { label: fullscreen ? label(labels, "Exit Fullscreen") : label(labels, "Enter Fullscreen"), icon: fullscreen ? ExitFullscreenIcon : EnterFullscreenIcon, renderIcon: fullscreen ? render.iconExitFullscreen : render.iconEnterFullscreen, onClick: toggleFullscreen }));
 };
-export const Fullscreen = ({ augment }) => {
+const Fullscreen = ({ augment }) => {
     augment(({ toolbar: { buttons, ...restToolbar }, ...restProps }) => ({
         toolbar: {
             buttons: [
@@ -104,3 +104,5 @@ export const Fullscreen = ({ augment }) => {
         ...restProps,
     }));
 };
+export { Fullscreen, FullscreenButton };
+export default Fullscreen;

package/dist/plugins/Inline.d.ts

@@ -5,6 +5,8 @@ declare module "../types.js" {
         inline?: React.HTMLAttributes<HTMLDivElement>;
     }
 }
-export declare const InlineContainer: Component;
-export declare const InlineModule: import("../types.js").Module;
-export declare const Inline: Plugin;
+declare const InlineContainer: Component;
+declare const InlineModule: import("../types.js").Module;
+declare const Inline: Plugin;
+export { Inline, InlineModule, InlineContainer };
+export default Inline;

package/dist/plugins/Inline.js

@@ -1,8 +1,8 @@
 import * as React from "react";
 import { createModule } from "../core/index.js";
-export const InlineContainer = ({ inline, children }) => React.createElement("div", { ...inline }, children);
-export const InlineModule = createModule("inline", InlineContainer);
-export const Inline = ({ augment, replace, remove }) => {
+const InlineContainer = ({ inline, children }) => React.createElement("div", { ...inline }, children);
+const InlineModule = createModule("inline", InlineContainer);
+const Inline = ({ augment, replace, remove }) => {
     augment(({ toolbar: { buttons, ...restToolbar }, open, close, ...restProps }) => ({
         open: true,
         close: () => { },
@@ -16,3 +16,5 @@ export const Inline = ({ augment, replace, remove }) => {
     remove("no-scroll");
     replace("portal", InlineModule);
 };
+export { Inline, InlineModule, InlineContainer };
+export default Inline;

package/dist/plugins/Video.d.ts

@@ -15,7 +15,9 @@ declare module "../types.js" {
         SlideVideo: SlideVideo;
     }
 }
-export declare const VideoSlide: ({ slide: { sources, poster, width, height } }: {
+declare const VideoSlide: ({ slide: { sources, poster, width, height } }: {
     slide: SlideVideo;
 }) => JSX.Element;
-export declare const Video: Plugin;
+declare const Video: Plugin;
+export { Video, VideoSlide };
+export default Video;

package/dist/plugins/Video.js

@@ -12,7 +12,7 @@ SlideTypesPropTypes.push(PropTypes.shape({
         type: PropTypes.string.isRequired,
     }).isRequired),
 }));
-export const VideoSlide = ({ slide: { sources, poster, width, height } }) => {
+const VideoSlide = ({ slide: { sources, poster, width, height } }) => {
     const { setContainerRef, containerRect } = useContainerRect();
     const scaleWidthAndHeight = () => {
         if (!width || !height || !containerRect)
@@ -28,7 +28,7 @@ export const VideoSlide = ({ slide: { sources, poster, width, height } }) => {
             height: "100%",
         }, 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 })))))))));
 };
-export const Video = ({ augment }) => {
+const Video = ({ augment }) => {
     augment(({ render: { slide: renderSlide, ...restRender }, ...restProps }) => ({
         render: {
             slide: (slide) => {
@@ -42,3 +42,5 @@ export const Video = ({ augment }) => {
         ...restProps,
     }));
 };
+export { Video, VideoSlide };
+export default Video;

package/dist/types.d.ts

@@ -60,7 +60,17 @@ export declare const LightboxPropTypes: {
     close: PropTypes.Validator<(...args: any[]) => any>;
     index: PropTypes.Validator<number>;
     slides: PropTypes.Validator<any[]>;
-    render: PropTypes.Validator<PropTypes.InferProps<{}>>;
+    render: PropTypes.Validator<PropTypes.InferProps<{
+        slide: PropTypes.Requireable<(...args: any[]) => any>;
+        iconPrev: PropTypes.Requireable<(...args: any[]) => any>;
+        iconNext: PropTypes.Requireable<(...args: any[]) => any>;
+        iconClose: PropTypes.Requireable<(...args: any[]) => any>;
+        iconLoading: PropTypes.Requireable<(...args: any[]) => any>;
+        iconError: PropTypes.Requireable<(...args: any[]) => any>;
+        buttonPrev: PropTypes.Requireable<(...args: any[]) => any>;
+        buttonNext: PropTypes.Requireable<(...args: any[]) => any>;
+        buttonClose: PropTypes.Requireable<(...args: any[]) => any>;
+    }>>;
     plugins: PropTypes.Validator<((...args: any[]) => any)[]>;
     toolbar: PropTypes.Validator<PropTypes.InferProps<{
         buttons: PropTypes.Validator<(string | number | boolean | PropTypes.ReactElementLike | PropTypes.ReactNodeArray | null | undefined)[]>;
@@ -76,7 +86,13 @@ export declare const LightboxPropTypes: {
         fade: PropTypes.Validator<number>;
         swipe: PropTypes.Validator<number>;
     }>>;
-    on: PropTypes.Validator<PropTypes.InferProps<{}>>;
+    on: PropTypes.Validator<PropTypes.InferProps<{
+        view: PropTypes.Requireable<(...args: any[]) => any>;
+        entering: PropTypes.Requireable<(...args: any[]) => any>;
+        entered: PropTypes.Requireable<(...args: any[]) => any>;
+        exiting: PropTypes.Requireable<(...args: any[]) => any>;
+        exited: PropTypes.Requireable<(...args: any[]) => any>;
+    }>>;
 };
 export declare const LightboxDefaultProps: {
     open: boolean;

package/dist/types.js

@@ -18,7 +18,17 @@ export const LightboxPropTypes = {
     close: PropTypes.func.isRequired,
     index: PropTypes.number.isRequired,
     slides: PropTypes.arrayOf(PropTypes.oneOfType(SlideTypesPropTypes).isRequired).isRequired,
-    render: PropTypes.shape({}).isRequired,
+    render: PropTypes.shape({
+        slide: PropTypes.func,
+        iconPrev: PropTypes.func,
+        iconNext: PropTypes.func,
+        iconClose: PropTypes.func,
+        iconLoading: PropTypes.func,
+        iconError: PropTypes.func,
+        buttonPrev: PropTypes.func,
+        buttonNext: PropTypes.func,
+        buttonClose: PropTypes.func,
+    }).isRequired,
     plugins: PropTypes.arrayOf(PropTypes.func.isRequired).isRequired,
     toolbar: PropTypes.shape({
         buttons: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.oneOf(["close"]), PropTypes.node])).isRequired,
@@ -34,7 +44,13 @@ export const LightboxPropTypes = {
         fade: PropTypes.number.isRequired,
         swipe: PropTypes.number.isRequired,
     }).isRequired,
-    on: PropTypes.shape({}).isRequired,
+    on: PropTypes.shape({
+        view: PropTypes.func,
+        entering: PropTypes.func,
+        entered: PropTypes.func,
+        exiting: PropTypes.func,
+        exited: PropTypes.func,
+    }).isRequired,
 };
 export const LightboxDefaultProps = {
     open: false,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "yet-another-react-lightbox",
-    "version": "1.2.2",
-    "description": "Modern lightbox component for React",
+    "version": "1.3.1",
+    "description": "Modern React lightbox component",
     "author": "Igor Danchenko",
     "license": "MIT",
     "type": "module",
@@ -82,8 +82,8 @@
         "@types/jest": "^27.5.1",
         "@types/react": "^18.0.9",
         "@types/react-dom": "^18.0.5",
-        "@typescript-eslint/eslint-plugin": "^5.26.0",
-        "@typescript-eslint/parser": "^5.26.0",
+        "@typescript-eslint/eslint-plugin": "^5.27.0",
+        "@typescript-eslint/parser": "^5.27.0",
         "autoprefixer": "^10.4.7",
         "eslint": "^8.16.0",
         "eslint-config-airbnb": "^19.0.4",
@@ -97,7 +97,7 @@
         "husky": "^8.0.1",
         "jest": "^28.1.0",
         "jest-environment-jsdom": "^28.1.0",
-        "lint-staged": "^12.4.2",
+        "lint-staged": "^12.4.3",
         "npm-run-all": "^4.1.5",
         "postcss": "^8.4.14",
         "postcss-cli": "^9.1.0",