@lumx/react 3.9.2-alpha.5 → 3.9.2-alpha.7

package/package.json

@@ -6,8 +6,8 @@
         "url": "https://github.com/lumapps/design-system/issues"
     },
     "dependencies": {
-        "@lumx/core": "^3.9.2-alpha.5",
-        "@lumx/icons": "^3.9.2-alpha.5",
+        "@lumx/core": "^3.9.2-alpha.7",
+        "@lumx/icons": "^3.9.2-alpha.7",
         "@popperjs/core": "^2.5.4",
         "body-scroll-lock": "^3.1.5",
         "classnames": "^2.3.2",
@@ -57,7 +57,7 @@
         "jest-environment-jsdom": "29.1.2",
         "react": "^17.0.2",
         "react-dom": "^17.0.2",
-        "rollup": "2.26.10",
+        "rollup": "2.79.2",
         "rollup-plugin-analyzer": "^3.3.0",
         "rollup-plugin-babel": "^4.4.0",
         "rollup-plugin-cleaner": "^1.0.0",
@@ -110,5 +110,5 @@
         "build:storybook": "storybook build"
     },
     "sideEffects": false,
-    "version": "3.9.2-alpha.5"
+    "version": "3.9.2-alpha.7"
 }

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

@@ -145,11 +145,18 @@ describe(`<${ImageLightbox.displayName}>`, () => {
 
             // Focus moved to the close button
             const imageLightbox = queries.getImageLightbox();
-            expect(queries.queryCloseButton(imageLightbox)).toHaveFocus();
+            const closeButton = queries.queryCloseButton(imageLightbox);
+            expect(closeButton).toHaveFocus();
+            const tooltip = screen.getByRole('tooltip', { name: 'Close' });
+            expect(tooltip).toBeInTheDocument();
 
             // Image lightbox opened on the correct image
             expect(queries.queryImage(imageLightbox, 'Image 2')).toBeInTheDocument();
 
+            // Close tooltip
+            await userEvent.keyboard('{escape}');
+            expect(tooltip).not.toBeInTheDocument();
+
             // Close on escape
             await userEvent.keyboard('{escape}');
             expect(imageLightbox).not.toBeInTheDocument();

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

@@ -41,13 +41,12 @@ export function useImageLightbox<P extends Partial<ImageLightboxProps>>(
     const propsRef = React.useRef(props);
 
     React.useEffect(() => {
-        const newProps = { ...props };
-        if (newProps?.images) {
-            newProps.images = newProps.images.map((image) => ({ imgRef: React.createRef(), ...image }));
-        }
-        propsRef.current = newProps;
+        propsRef.current = props;
     }, [props]);
 
+    // Keep reference for each image elements
+    const imageRefsRef = React.useRef<Array<React.RefObject<HTMLImageElement>>>([]);
+
     const currentImageRef = React.useRef<HTMLImageElement>(null);
     const [imageLightboxProps, setImageLightboxProps] = React.useState(
         () => ({ ...EMPTY_PROPS, ...props }) as ManagedProps & P,
@@ -61,8 +60,8 @@ export function useImageLightbox<P extends Partial<ImageLightboxProps>>(
             if (!currentImage) {
                 return;
             }
-            const currentIndex = propsRef.current?.images?.findIndex(
-                ({ imgRef }) => (imgRef as any)?.current === currentImage,
+            const currentIndex = imageRefsRef.current.findIndex(
+                (imageRef) => imageRef.current === currentImage,
             ) as number;
 
             await startViewTransition({
@@ -83,12 +82,20 @@ export function useImageLightbox<P extends Partial<ImageLightboxProps>>(
             // If we find an image inside the trigger, animate it in transition with the opening image
             const triggerImage = triggerImageRefs[activeImageIndex as any]?.current || findImage(triggerElement);
 
-            // Inject the trigger image as loading placeholder for better loading state
-            const imagesWithFallbackSize = propsRef.current?.images?.map((image, idx) => {
-                if (triggerImage && idx === activeImageIndex && !image.loadingPlaceholderImageRef) {
-                    return { ...image, loadingPlaceholderImageRef: { current: triggerImage } };
+            // Inject refs to improve transition and loading style
+            const images = propsRef.current?.images?.map((image, idx) => {
+                // Get or create image reference
+                let imgRef = imageRefsRef.current[idx];
+                if (!imgRef) {
+                    imgRef = React.createRef();
+                    imageRefsRef.current[idx] = imgRef;
                 }
-                return image;
+
+                // Try to use the trigger image as the loading placeholder
+                const loadingPlaceholderImageRef =
+                    triggerImage && idx === activeImageIndex ? { current: triggerImage } : undefined;
+
+                return { loadingPlaceholderImageRef, ...image, imgRef };
             });
 
             await startViewTransition({
@@ -104,7 +111,7 @@ export function useImageLightbox<P extends Partial<ImageLightboxProps>>(
                             close();
                             prevProps?.onClose?.();
                         },
-                        images: imagesWithFallbackSize,
+                        images,
                         activeImageIndex: activeImageIndex || 0,
                     }));
                 },

package/src/components/tooltip/Tooltip.stories.tsx

@@ -2,8 +2,10 @@ import { Button, Dialog, Dropdown, Placement, Tooltip } from '@lumx/react';
 import React, { useState } from 'react';
 import { getSelectArgType } from '@lumx/react/stories/controls/selectArgType';
 import { withChromaticForceScreenSize } from '@lumx/react/stories/decorators/withChromaticForceScreenSize';
+import { ARIA_LINK_MODES } from '@lumx/react/components/tooltip/constants';
 
 const placements = [Placement.TOP, Placement.BOTTOM, Placement.RIGHT, Placement.LEFT];
+const CLOSE_MODES = ['hide', 'unmount'];
 
 export default {
     title: 'LumX components/tooltip/Tooltip',
@@ -11,6 +13,9 @@ export default {
     args: Tooltip.defaultProps,
     argTypes: {
         placement: getSelectArgType(placements),
+        children: { control: false },
+        closeMode: { control: { type: 'inline-radio' }, options: CLOSE_MODES },
+        ariaLinkMode: { control: { type: 'inline-radio' }, options: ARIA_LINK_MODES },
     },
     decorators: [
         // Force minimum chromatic screen size to make sure the dialog appears in view.

package/src/components/tooltip/Tooltip.test.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 
-import { Button, IconButton } from '@lumx/react';
+import { Button } from '@lumx/react';
 import { screen, render } from '@testing-library/react';
 import { queryAllByTagName, queryByClassName } from '@lumx/react/testing/utils/queries';
 import { commonTestsSuiteRTL } from '@lumx/react/testing/utils';
@@ -51,7 +51,6 @@ describe(`<${Tooltip.displayName}>`, () => {
             // Default placement
             expect(tooltip).toHaveAttribute('data-popper-placement', 'bottom');
             expect(anchorWrapper).toBeInTheDocument();
-            expect(anchorWrapper).toHaveAttribute('aria-describedby', tooltip?.id);
         });
 
         it('should render with custom placement', async () => {
@@ -65,25 +64,6 @@ describe(`<${Tooltip.displayName}>`, () => {
             expect(tooltip).toHaveAttribute('data-popper-placement', 'top');
         });
 
-        it('should wrap unknown children and not add aria-describedby when closed', async () => {
-            const { anchorWrapper } = await setup({
-                label: 'Tooltip label',
-                children: 'Anchor',
-                forceOpen: false,
-            });
-            expect(anchorWrapper).not.toHaveAttribute('aria-describedby');
-        });
-
-        it('should not wrap Button and not add aria-describedby when closed', async () => {
-            await setup({
-                label: 'Tooltip label',
-                children: <Button>Anchor</Button>,
-                forceOpen: false,
-            });
-            const button = screen.queryByRole('button', { name: 'Anchor' });
-            expect(button).not.toHaveAttribute('aria-describedby');
-        });
-
         it('should not wrap Button', async () => {
             const { tooltip, anchorWrapper } = await setup({
                 label: 'Tooltip label',
@@ -96,35 +76,6 @@ describe(`<${Tooltip.displayName}>`, () => {
             expect(button).toHaveAttribute('aria-describedby', tooltip?.id);
         });
 
-        it('should not add aria-describedby if button label is the same as tooltip label', async () => {
-            const label = 'Tooltip label';
-            render(<IconButton label={label} tooltipProps={{ forceOpen: true }} />);
-            const tooltip = screen.queryByRole('tooltip', { name: label });
-            expect(tooltip).toBeInTheDocument();
-            const button = screen.queryByRole('button', { name: label });
-            expect(button).not.toHaveAttribute('aria-describedby');
-        });
-
-        it('should keep anchor aria-describedby if button label is the same as tooltip label', async () => {
-            const label = 'Tooltip label';
-            render(<IconButton label={label} aria-describedby=":header-1:" tooltipProps={{ forceOpen: true }} />);
-            const tooltip = screen.queryByRole('tooltip', { name: label });
-            expect(tooltip).toBeInTheDocument();
-            const button = screen.queryByRole('button', { name: label });
-            expect(button).toHaveAttribute('aria-describedby', ':header-1:');
-        });
-
-        it('should concat aria-describedby if already exists', async () => {
-            const { tooltip } = await setup({
-                label: 'Tooltip label',
-                children: <Button aria-describedby=":header-1:">Anchor</Button>,
-                forceOpen: true,
-            });
-            expect(tooltip).toBeInTheDocument();
-            const button = screen.queryByRole('button', { name: 'Anchor' });
-            expect(button).toHaveAttribute('aria-describedby', `:header-1: ${tooltip?.id}`);
-        });
-
         it('should wrap disabled Button', async () => {
             const { tooltip, anchorWrapper } = await setup({
                 label: 'Tooltip label',
@@ -172,17 +123,166 @@ describe(`<${Tooltip.displayName}>`, () => {
             expect(ref.current === element).toBe(true);
         });
 
-        it('should render in closeMode=hide', async () => {
-            const { tooltip } = await setup({
-                label: 'Tooltip label',
-                children: <Button>Anchor</Button>,
-                closeMode: 'hide',
-                forceOpen: false,
+        describe('closeMode="hide"', () => {
+            it('should not render with empty label', async () => {
+                const { tooltip, anchorWrapper } = await setup({
+                    label: undefined,
+                    forceOpen: true,
+                    closeMode: 'hide',
+                });
+                expect(tooltip).not.toBeInTheDocument();
+                expect(anchorWrapper).not.toBeInTheDocument();
+            });
+
+            it('should render hidden', async () => {
+                const { tooltip } = await setup({
+                    label: 'Tooltip label',
+                    children: <Button>Anchor</Button>,
+                    closeMode: 'hide',
+                    forceOpen: false,
+                });
+                expect(tooltip).toBeInTheDocument();
+                expect(tooltip).toHaveClass('lumx-tooltip--is-hidden');
+
+                const anchor = screen.getByRole('button', { name: 'Anchor' });
+                await userEvent.hover(anchor);
+                expect(tooltip).not.toHaveClass('lumx-tooltip--is-hidden');
+            });
+        });
+
+        describe('ariaLinkMode="aria-describedby"', () => {
+            it('should add aria-describedby on anchor on open', async () => {
+                await setup({
+                    label: 'Tooltip label',
+                    forceOpen: false,
+                    children: <Button aria-describedby=":description1:">Anchor</Button>,
+                });
+                const anchor = screen.getByRole('button', { name: 'Anchor' });
+                expect(anchor).toHaveAttribute('aria-describedby', ':description1:');
+
+                await userEvent.hover(anchor);
+                const tooltip = screen.queryByRole('tooltip');
+                expect(anchor).toHaveAttribute('aria-describedby', `:description1: ${tooltip?.id}`);
+            });
+
+            it('should always add aria-describedby on anchor with closeMode="hide"', async () => {
+                const { tooltip } = await setup({
+                    label: 'Tooltip label',
+                    forceOpen: false,
+                    children: <Button aria-describedby=":description1:">Anchor</Button>,
+                    closeMode: 'hide',
+                });
+                const anchor = screen.getByRole('button', { name: 'Anchor' });
+                expect(anchor).toHaveAttribute('aria-describedby', `:description1: ${tooltip?.id}`);
+            });
+
+            it('should skip aria-describedby if anchor has label', async () => {
+                const { tooltip } = await setup({
+                    label: 'Tooltip label',
+                    forceOpen: true,
+                    children: (
+                        <Button aria-describedby=":description1:" aria-label="Tooltip label">
+                            Anchor
+                        </Button>
+                    ),
+                });
+                expect(tooltip).toBeInTheDocument();
+                expect(screen.getByRole('button')).toHaveAttribute('aria-describedby', `:description1:`);
+            });
+
+            it('should add aria-describedby on anchor wrapper on open', async () => {
+                const { anchorWrapper } = await setup({
+                    label: 'Tooltip label',
+                    forceOpen: false,
+                    children: 'Anchor',
+                });
+                expect(anchorWrapper).not.toHaveAttribute('aria-describedby');
+
+                await userEvent.hover(anchorWrapper as any);
+                const tooltip = screen.queryByRole('tooltip');
+                expect(anchorWrapper).toHaveAttribute('aria-describedby', tooltip?.id);
+            });
+
+            it('should always add aria-describedby on anchor wrapper with closeMode="hide"', async () => {
+                const { tooltip, anchorWrapper } = await setup({
+                    label: 'Tooltip label',
+                    forceOpen: false,
+                    children: 'Anchor',
+                    closeMode: 'hide',
+                });
+                expect(anchorWrapper).toHaveAttribute('aria-describedby', `${tooltip?.id}`);
+            });
+        });
+
+        describe('ariaLinkMode="aria-labelledby"', () => {
+            it('should add aria-labelledby on anchor on open', async () => {
+                await setup({
+                    label: 'Tooltip label',
+                    forceOpen: false,
+                    children: <Button aria-labelledby=":label1:">Anchor</Button>,
+                    ariaLinkMode: 'aria-labelledby',
+                });
+                const anchor = screen.getByRole('button', { name: 'Anchor' });
+                expect(anchor).toHaveAttribute('aria-labelledby', ':label1:');
+
+                await userEvent.hover(anchor);
+                const tooltip = screen.queryByRole('tooltip');
+                expect(anchor).toHaveAttribute('aria-labelledby', `:label1: ${tooltip?.id}`);
+            });
+
+            it('should always add aria-labelledby on anchor with closeMode="hide"', async () => {
+                const label = 'Tooltip label';
+                const { tooltip } = await setup({
+                    label,
+                    forceOpen: false,
+                    children: <Button aria-labelledby=":label1:">Anchor</Button>,
+                    ariaLinkMode: 'aria-labelledby',
+                    closeMode: 'hide',
+                });
+                const anchor = screen.queryByRole('button', { name: label });
+                expect(anchor).toBeInTheDocument();
+                expect(anchor).toHaveAttribute('aria-labelledby', `:label1: ${tooltip?.id}`);
+            });
+
+            it('should skip aria-labelledby if anchor has label', async () => {
+                const { tooltip } = await setup({
+                    label: 'Tooltip label',
+                    forceOpen: true,
+                    children: (
+                        <Button aria-labelledby=":label1:" aria-label="Tooltip label">
+                            Anchor
+                        </Button>
+                    ),
+                    ariaLinkMode: 'aria-labelledby',
+                });
+                expect(tooltip).toBeInTheDocument();
+                expect(screen.getByRole('button')).toHaveAttribute('aria-labelledby', `:label1:`);
+            });
+
+            it('should add aria-labelledby on anchor wrapper on open', async () => {
+                const { anchorWrapper } = await setup({
+                    label: 'Tooltip label',
+                    forceOpen: false,
+                    children: 'Anchor',
+                    ariaLinkMode: 'aria-labelledby',
+                });
+                expect(anchorWrapper).not.toHaveAttribute('aria-labelledby');
+
+                await userEvent.hover(anchorWrapper as any);
+                const tooltip = screen.queryByRole('tooltip');
+                expect(anchorWrapper).toHaveAttribute('aria-labelledby', tooltip?.id);
+            });
+
+            it('should always add aria-labelledby on anchor wrapper with closeMode="hide"', async () => {
+                const { tooltip, anchorWrapper } = await setup({
+                    label: 'Tooltip label',
+                    forceOpen: false,
+                    children: 'Anchor',
+                    ariaLinkMode: 'aria-labelledby',
+                    closeMode: 'hide',
+                });
+                expect(anchorWrapper).toHaveAttribute('aria-labelledby', `${tooltip?.id}`);
             });
-            expect(tooltip).toBeInTheDocument();
-            expect(tooltip).toHaveClass('lumx-tooltip--is-hidden');
-            const button = screen.queryByRole('button', { name: 'Anchor' });
-            expect(button).toHaveAttribute('aria-describedby', tooltip?.id);
         });
     });
 
@@ -203,7 +303,6 @@ describe(`<${Tooltip.displayName}>`, () => {
             // Tooltip opened
             tooltip = await screen.findByRole('tooltip', { name: 'Tooltip label' });
             expect(tooltip).toBeInTheDocument();
-            expect(button).toHaveAttribute('aria-describedby', tooltip?.id);
 
             // Un-hover anchor button
             await userEvent.unhover(button);

package/src/components/tooltip/Tooltip.tsx

@@ -11,10 +11,11 @@ import { useMergeRefs } from '@lumx/react/utils/mergeRefs';
 import { Placement } from '@lumx/react/components/popover';
 import { TooltipContextProvider } from '@lumx/react/components/tooltip/context';
 import { useId } from '@lumx/react/hooks/useId';
+import { usePopper } from '@lumx/react/hooks/usePopper';
 
+import { ARIA_LINK_MODES } from '@lumx/react/components/tooltip/constants';
 import { useInjectTooltipRef } from './useInjectTooltipRef';
 import { useTooltipOpen } from './useTooltipOpen';
-import { usePopper } from '@lumx/react/hooks/usePopper';
 
 /** Position of the tooltip relative to the anchor element. */
 export type TooltipPlacement = Extract<Placement, 'top' | 'right' | 'bottom' | 'left'>;
@@ -33,6 +34,8 @@ export interface TooltipProps extends GenericProps, HasCloseMode {
     label?: string | null | false;
     /** Placement of the tooltip relative to the anchor. */
     placement?: TooltipPlacement;
+    /** Choose how the tooltip text should link to the anchor */
+    ariaLinkMode?: (typeof ARIA_LINK_MODES)[number];
 }
 
 /**
@@ -51,6 +54,7 @@ const CLASSNAME = getRootClassName(COMPONENT_NAME);
 const DEFAULT_PROPS: Partial<TooltipProps> = {
     placement: Placement.BOTTOM,
     closeMode: 'unmount',
+    ariaLinkMode: 'aria-describedby',
 };
 
 /**
@@ -66,7 +70,8 @@ const ARROW_SIZE = 8;
  * @return React element.
  */
 export const Tooltip: Comp<TooltipProps, HTMLDivElement> = forwardRef((props, ref) => {
-    const { label, children, className, delay, placement, forceOpen, closeMode, ...forwardedProps } = props;
+    const { label, children, className, delay, placement, forceOpen, closeMode, ariaLinkMode, ...forwardedProps } =
+        props;
     // Disable in SSR.
     if (!DOCUMENT) {
         return <>{children}</>;
@@ -89,8 +94,15 @@ export const Tooltip: Comp<TooltipProps, HTMLDivElement> = forwardRef((props, re
     const position = attributes?.popper?.['data-popper-placement'] ?? placement;
     const { isOpen: isActivated, onPopperMount } = useTooltipOpen(delay, anchorElement);
     const isOpen = (isActivated || forceOpen) && !!label;
-    const isMounted = isOpen || closeMode === 'hide';
-    const wrappedChildren = useInjectTooltipRef(children, setAnchorElement, isMounted, id, label);
+    const isMounted = !!label && (isOpen || closeMode === 'hide');
+    const wrappedChildren = useInjectTooltipRef({
+        children,
+        setAnchorElement,
+        isMounted,
+        id,
+        label,
+        ariaLinkMode: ariaLinkMode as any,
+    });
 
     const labelLines = label ? label.split('\n') : [];
 

package/src/components/tooltip/constants.ts

@@ -0,0 +1 @@
+export const ARIA_LINK_MODES = ['aria-describedby', 'aria-labelledby'] as const;

package/src/components/tooltip/useInjectTooltipRef.tsx

@@ -2,27 +2,30 @@ import React, { cloneElement, ReactNode, useMemo } from 'react';
 
 import { mergeRefs } from '@lumx/react/utils/mergeRefs';
 
+interface Options {
+    /** Original tooltip anchor */
+    children: ReactNode;
+    /** Set tooltip anchor element */
+    setAnchorElement: (e: HTMLDivElement) => void;
+    /** Whether the tooltip is open or not */
+    isMounted: boolean | undefined;
+    /** Tooltip id */
+    id: string;
+    /** Tooltip label*/
+    label?: string | null | false;
+    /** Choose how the tooltip text should link to the anchor */
+    ariaLinkMode: 'aria-describedby' | 'aria-labelledby';
+}
+
 /**
  * Add ref and ARIA attribute(s) in tooltip children or wrapped children.
  * Button, IconButton, Icon and React HTML elements don't need to be wrapped but any other kind of children (array, fragment, custom components)
  * will be wrapped in a <span>.
- *
- * @param  children         Original tooltip anchor.
- * @param  setAnchorElement Set tooltip anchor element.
- * @param  isOpen           Whether the tooltip is open or not.
- * @param  id               Tooltip id.
- * @param  label            Tooltip label.
- * @return tooltip anchor.
  */
-export const useInjectTooltipRef = (
-    children: ReactNode,
-    setAnchorElement: (e: HTMLDivElement) => void,
-    isOpen: boolean | undefined,
-    id: string,
-    label?: string | null | false,
-): ReactNode => {
-    // Only add description when open
-    const describedBy = isOpen ? id : undefined;
+export const useInjectTooltipRef = (options: Options): ReactNode => {
+    const { children, setAnchorElement, isMounted, id, label, ariaLinkMode } = options;
+    // Only add link when mounted
+    const linkId = isMounted ? id : undefined;
 
     return useMemo(() => {
         if (!label) return children;
@@ -32,18 +35,21 @@ export const useInjectTooltipRef = (
             const ref = mergeRefs((children as any).ref, setAnchorElement);
             const props = { ...children.props, ref };
 
-            // Add current tooltip to the aria-describedby if the label is not already present
-            if (label !== props['aria-label'] && describedBy) {
-                props['aria-describedby'] = [props['aria-describedby'], describedBy].filter(Boolean).join(' ');
+            // Do not add label/description if the tooltip label is already in aria-label
+            if (linkId && label !== props['aria-label']) {
+                if (props[ariaLinkMode]) props[ariaLinkMode] += ' ';
+                else props[ariaLinkMode] = '';
+                props[ariaLinkMode] += linkId;
             }
 
             return cloneElement(children, props);
         }
 
+        const aria = linkId ? { [ariaLinkMode]: linkId } : undefined;
         return (
-            <div className="lumx-tooltip-anchor-wrapper" ref={setAnchorElement} aria-describedby={describedBy}>
+            <div className="lumx-tooltip-anchor-wrapper" ref={setAnchorElement} {...aria}>
                 {children}
             </div>
         );
-    }, [children, setAnchorElement, describedBy, label]);
+    }, [label, children, setAnchorElement, linkId, ariaLinkMode]);
 };

package/src/utils/type.ts

@@ -59,7 +59,6 @@ export interface HasClassName {
     className?: string;
 }
 
-
 export interface HasCloseMode {
     /**
      * Choose how the children are hidden when closed