yet-another-react-lightbox 2.5.1 → 2.6.1

package/dist/types.d.ts

@@ -78,13 +78,22 @@ export interface CarouselSettings {
 }
 /** Animation settings */
 export interface AnimationSettings {
-    /** fade-in / fade-out animation duration */
-    fade: number;
-    /** swipe animation duration */
-    swipe: number;
-    /** override for `swipe` animation duration when using keyboard navigation or navigation buttons */
-    navigation?: number;
+    /** fade-in / fade-out animation settings */
+    fade: AnimationSpec;
+    /** swipe animation settings */
+    swipe: AnimationSpec;
+    /** override for `swipe` animation settings when using keyboard navigation or navigation buttons */
+    navigation?: AnimationSpec;
 }
+/** Animation duration or animation settings */
+export type AnimationSpec = {
+    /** animation duration */
+    duration?: number;
+    /** animation easing function */
+    easing?: string;
+}
+/** animation duration */
+ | number;
 /** Controller settings */
 export interface ControllerSettings {
     /** if true, the lightbox captures focus when it opens */
@@ -96,38 +105,49 @@ export interface ControllerSettings {
     /** if `true`, close the lightbox when the backdrop is clicked */
     closeOnBackdropClick: boolean;
 }
-/** Custom render functions. */
-export interface Render {
-    /** render custom slide type, or override the default image slide */
-    slide?: (
+/** Render function */
+export type RenderFunction<T = void> = (props: T) => React.ReactNode;
+/** `render.slide` render function props */
+export type RenderSlideProps = [
     /** slide */
-    slide: Slide, 
+    slide: Slide,
     /** slide offset (`0` - current slide, `1` - next slide, `-1` - previous slide, etc.) */
-    offset: number, 
+    offset: number,
     /** container rect */
-    rect: ContainerRect) => React.ReactNode;
+    rect: ContainerRect
+];
+/** `render.slideHeader` render function props */
+export type RenderSlideHeaderProps = [slide: Slide];
+/** `render.slideFooter` render function props */
+export type RenderSlideFooterProps = [slide: Slide];
+/** `render.slideContainer` render function props */
+export type RenderSlideContainerProps = [slide: Slide, children: React.ReactNode];
+/** Custom render functions. */
+export interface Render {
+    /** render custom slide type, or override the default image slide */
+    slide?: (...props: RenderSlideProps) => React.ReactNode;
     /** render custom slide header */
-    slideHeader?: (slide: Slide) => React.ReactNode;
+    slideHeader?: (...props: RenderSlideHeaderProps) => React.ReactNode;
     /** render custom slide footer */
-    slideFooter?: (slide: Slide) => React.ReactNode;
+    slideFooter?: (...props: RenderSlideFooterProps) => React.ReactNode;
     /** render custom slide container */
-    slideContainer?: (slide: Slide, children: React.ReactNode) => React.ReactNode;
+    slideContainer?: (...props: RenderSlideContainerProps) => React.ReactNode;
     /** render custom Prev icon */
-    iconPrev?: () => React.ReactNode;
+    iconPrev?: RenderFunction;
     /** render custom Next icon */
-    iconNext?: () => React.ReactNode;
+    iconNext?: RenderFunction;
     /** render custom Close icon */
-    iconClose?: () => React.ReactNode;
+    iconClose?: RenderFunction;
     /** render custom Loading icon */
-    iconLoading?: () => React.ReactNode;
+    iconLoading?: RenderFunction;
     /** render custom Error icon */
-    iconError?: () => React.ReactNode;
+    iconError?: RenderFunction;
     /** render custom Prev button */
-    buttonPrev?: () => React.ReactNode;
+    buttonPrev?: RenderFunction;
     /** render custom Next button */
-    buttonNext?: () => React.ReactNode;
+    buttonNext?: RenderFunction;
     /** render custom Close button */
-    buttonClose?: () => React.ReactNode;
+    buttonClose?: RenderFunction;
 }
 /** Lifecycle callbacks */
 export interface Callbacks {
@@ -188,9 +208,9 @@ export interface ToolbarSettings {
     buttons: ("close" | React.ReactNode)[];
 }
 /** Lightbox component properties */
-export type ComponentProps = Omit<LightboxProps, "plugins">;
+export type ComponentProps = React.PropsWithChildren<Omit<LightboxProps, "plugins">>;
 /** Lightbox component */
-export type Component = React.ComponentType<React.PropsWithChildren<ComponentProps>>;
+export type Component = React.ComponentType<ComponentProps>;
 /** Lightbox module */
 export type Module = {
     /** module name */

package/package.json

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