@lumx/react 3.7.6-alpha.0 → 3.7.6-alpha.2

package/package.json

@@ -7,8 +7,8 @@
     },
     "dependencies": {
         "@juggle/resize-observer": "^3.2.0",
-        "@lumx/core": "^3.7.6-alpha.0",
-        "@lumx/icons": "^3.7.6-alpha.0",
+        "@lumx/core": "^3.7.6-alpha.2",
+        "@lumx/icons": "^3.7.6-alpha.2",
         "@popperjs/core": "^2.5.4",
         "body-scroll-lock": "^3.1.5",
         "classnames": "^2.3.2",
@@ -112,5 +112,5 @@
         "build:storybook": "storybook build"
     },
     "sideEffects": false,
-    "version": "3.7.6-alpha.0"
+    "version": "3.7.6-alpha.2"
 }

package/src/components/image-lightbox/ImageLightbox.stories.tsx

@@ -119,10 +119,12 @@ export const MultipleImagesWithZoom = {
 export const WithButtonTrigger = {
     decorators: [
         (Story: any, { args }: any) => {
-            const { getTriggerProps, imageLightboxProps } = ImageLightbox.useImageLightbox([
-                { image: IMAGES.portrait1s200, alt: 'Image 1' },
-                { image: IMAGES.landscape1s200, alt: 'Image 2' },
-            ]);
+            const { getTriggerProps, imageLightboxProps } = ImageLightbox.useImageLightbox({
+                images: [
+                    { image: IMAGES.portrait1s200, alt: 'Image 1' },
+                    { image: IMAGES.landscape1s200, alt: 'Image 2' },
+                ],
+            });
             return (
                 <>
                     <Story args={{ ...args, ...imageLightboxProps }} />
@@ -143,7 +145,7 @@ export const WithMosaicTrigger = {
     args: { ...SLIDESHOW_PROPS, ...ZOOM_PROPS },
     decorators: [
         (Story: any, { args }: any) => {
-            const { getTriggerProps, imageLightboxProps } = ImageLightbox.useImageLightbox(MULTIPLE_IMAGES);
+            const { getTriggerProps, imageLightboxProps } = ImageLightbox.useImageLightbox({ images: MULTIPLE_IMAGES });
             return (
                 <>
                     <Story args={{ ...args, ...imageLightboxProps }} />

package/src/components/image-lightbox/useImageLightbox.tsx

@@ -23,24 +23,33 @@ const EMPTY_PROPS: ManagedProps = { isOpen: false, images: [], parentElement: Re
  * - Associate a trigger with an image to display on open
  * - Automatically provide a view transition between an image trigger and the displayed image on open & close
  *
- * @param images Images to display in the image lightbox
+ * @param initialProps Images to display in the image lightbox
  */
-export function useImageLightbox(images: ImageLightboxProps['images'] = []): {
+export function useImageLightbox<P extends Partial<ImageLightboxProps>>(
+    initialProps: P,
+): {
     /**
      * Generates trigger props
      * @param index Provide an index to choose which image to display when the image lightbox opens.
      * */
     getTriggerProps: (index?: number) => { onClick: React.MouseEventHandler; ref: React.Ref<any> };
     /** Props to forward to the ImageLightbox */
-    imageLightboxProps: ManagedProps;
+    imageLightboxProps: P & ManagedProps;
 } {
+    const { images = [], ...otherProps } = initialProps;
+
+    const basePropsRef = React.useRef(EMPTY_PROPS as P & ManagedProps);
+    React.useEffect(() => {
+        basePropsRef.current = { ...EMPTY_PROPS, ...otherProps } as P & ManagedProps;
+    }, [otherProps]);
+
     const imagesPropsRef = React.useRef(images);
     React.useEffect(() => {
         imagesPropsRef.current = images.map((props) => ({ imgRef: React.createRef(), ...props }));
     }, [images]);
 
     const currentImageRef = React.useRef<HTMLImageElement>(null);
-    const [imageLightboxProps, setImageLightboxProps] = React.useState<ManagedProps>(EMPTY_PROPS);
+    const [imageLightboxProps, setImageLightboxProps] = React.useState<P & ManagedProps>(basePropsRef.current);
 
     const getTriggerProps = React.useMemo(() => {
         const triggerImageRefs: Record<number, React.RefObject<HTMLImageElement>> = {};
@@ -57,7 +66,7 @@ export function useImageLightbox(images: ImageLightboxProps['images'] = []): {
             await startViewTransition({
                 changes() {
                     // Close lightbox with reset empty props
-                    setImageLightboxProps(({ parentElement }) => ({ ...EMPTY_PROPS, parentElement }));
+                    setImageLightboxProps(({ parentElement }) => ({ ...basePropsRef.current, parentElement }));
                 },
                 // Morph from the image in lightbox to the image in trigger
                 viewTransitionName: {
@@ -90,6 +99,7 @@ export function useImageLightbox(images: ImageLightboxProps['images'] = []): {
                 changes: () => {
                     // Open lightbox with setup props
                     setImageLightboxProps({
+                        ...basePropsRef.current,
                         activeImageRef: currentImageRef,
                         parentElement: { current: triggerElement },
                         isOpen: true,