@codecademy/gamut 67.6.1-alpha.1bf8a5.0 → 67.6.1-alpha.74920d.0

package/dist/Tip/InfoTip/index.js

@@ -1,17 +1,19 @@
 import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react';
 import { getFocusableElements as getFocusableElementsUtil } from '../../utils/focus';
+import { extractTextContent } from '../../utils/react';
 import { FloatingTip } from '../shared/FloatingTip';
 import { InlineTip } from '../shared/InlineTip';
 import { tipDefaultProps } from '../shared/types';
 import { isElementVisible } from '../shared/utils';
+import { ScreenreaderNavigableText } from './elements';
 import { InfoTipButton } from './InfoTipButton';
-import { jsx as _jsx } from "react/jsx-runtime";
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+const ARIA_HIDDEN_DELAY_MS = 1000;
+
+// Match native dialogs with open attribute, and role-based dialogs that aren't aria-hidden
 const MODAL_SELECTOR = 'dialog[open],[role="dialog"]:not([aria-hidden="true"]),[role="alertdialog"]:not([aria-hidden="true"])';
 export const InfoTip = ({
   alignment = 'top-right',
-  ariaLabel,
-  ariaLabelledby,
-  ariaRoleDescription = 'More information button',
   emphasis = 'low',
   info,
   onClick,
@@ -20,14 +22,25 @@ export const InfoTip = ({
 }) => {
   const isFloating = placement === 'floating';
   const [isTipHidden, setHideTip] = useState(true);
+  const [isAriaHidden, setIsAriaHidden] = useState(false);
+  const [shouldAnnounce, setShouldAnnounce] = useState(false);
   const [loaded, setLoaded] = useState(false);
   const wrapperRef = useRef(null);
   const buttonRef = useRef(null);
   const popoverContentNodeRef = useRef(null);
   const isInitialMount = useRef(true);
+  const ariaHiddenTimeoutRef = useRef(null);
+  const announceTimeoutRef = useRef(null);
   const getFocusableElements = useCallback(() => {
     return getFocusableElementsUtil(popoverContentNodeRef.current);
   }, []);
+  const clearAndSetTimeout = useCallback((timeoutRef, callback, delay) => {
+    clearTimeout(timeoutRef.current ?? undefined);
+    timeoutRef.current = setTimeout(() => {
+      callback();
+      timeoutRef.current = null;
+    }, delay);
+  }, []);
   const popoverContentRef = useCallback(node => {
     popoverContentNodeRef.current = node;
     if (node && !isTipHidden && isFloating) {
@@ -38,10 +51,24 @@ export const InfoTip = ({
   }, [onClick, isTipHidden, isFloating]);
   useEffect(() => {
     setLoaded(true);
+    const ariaHiddenTimeout = ariaHiddenTimeoutRef.current;
+    const announceTimeout = announceTimeoutRef.current;
+    return () => {
+      clearTimeout(ariaHiddenTimeout ?? undefined);
+      clearTimeout(announceTimeout ?? undefined);
+    };
   }, []);
   const setTipIsHidden = useCallback(nextTipState => {
     setHideTip(nextTipState);
-  }, []);
+    if (!nextTipState && !isFloating) {
+      clearAndSetTimeout(ariaHiddenTimeoutRef, () => setIsAriaHidden(true), ARIA_HIDDEN_DELAY_MS);
+    } else if (nextTipState) {
+      if (isAriaHidden) setIsAriaHidden(false);
+      setShouldAnnounce(false);
+      clearTimeout(ariaHiddenTimeoutRef.current ?? undefined);
+      ariaHiddenTimeoutRef.current = null;
+    }
+  }, [isAriaHidden, isFloating, clearAndSetTimeout]);
   const handleOutsideClick = useCallback(e => {
     const wrapper = wrapperRef.current;
     const isOutside = wrapper && (!(e.target instanceof HTMLElement) || !wrapper.contains(e.target));
@@ -52,7 +79,10 @@ export const InfoTip = ({
   const clickHandler = useCallback(() => {
     const currentTipState = !isTipHidden;
     setTipIsHidden(currentTipState);
-  }, [isTipHidden, setTipIsHidden]);
+    if (!currentTipState) {
+      clearAndSetTimeout(announceTimeoutRef, () => setShouldAnnounce(true), 0);
+    }
+  }, [isTipHidden, setTipIsHidden, clearAndSetTimeout]);
   useLayoutEffect(() => {
     if (isInitialMount.current) {
       isInitialMount.current = false;
@@ -90,18 +120,7 @@ export const InfoTip = ({
       const handleTabKeyInPopover = event => {
         if (event.key !== 'Tab' || event.shiftKey) return;
         const focusableElements = getFocusableElements();
-        const {
-          activeElement
-        } = document;
-
-        // If no focusable elements and popover itself has focus, wrap to button
-        if (focusableElements.length === 0) {
-          if (activeElement === popoverContentNodeRef.current) {
-            event.preventDefault();
-            buttonRef.current?.focus();
-          }
-          return;
-        }
+        if (focusableElements.length === 0) return;
         const lastElement = focusableElements[focusableElements.length - 1];
 
         // Only wrap forward: if on last element, wrap to button
@@ -122,35 +141,45 @@ export const InfoTip = ({
       };
     }
     return () => document.removeEventListener('keydown', handleGlobalEscapeKey, true);
-  }, [isTipHidden, isFloating, getFocusableElements, setTipIsHidden]);
-  useEffect(() => {
-    if (isTipHidden) return;
-    const timeoutId = setTimeout(() => {
-      popoverContentNodeRef.current?.focus();
-    }, 0);
-    return () => clearTimeout(timeoutId);
-  }, [isTipHidden]);
+  }, [isTipHidden, isFloating, setTipIsHidden, getFocusableElements]);
   const Tip = loaded && isFloating ? FloatingTip : InlineTip;
   const tipProps = useMemo(() => ({
     alignment,
     info,
     isTipHidden,
-    contentRef: popoverContentRef,
     wrapperRef,
+    ...(isFloating && {
+      popoverContentRef
+    }),
     ...rest
-  }), [alignment, info, isTipHidden, popoverContentRef, wrapperRef, rest]);
+  }), [alignment, info, isTipHidden, wrapperRef, isFloating, popoverContentRef, rest]);
+  const extractedTextContent = useMemo(() => extractTextContent(info), [info]);
+  const screenreaderInfo = shouldAnnounce && !isTipHidden ? extractedTextContent : '\xa0';
+  const screenreaderText = useMemo(() => /*#__PURE__*/_jsx(ScreenreaderNavigableText, {
+    "aria-hidden": isAriaHidden,
+    "aria-live": "assertive",
+    screenreader: true,
+    children: screenreaderInfo
+  }), [isAriaHidden, screenreaderInfo]);
+  const button = useMemo(() => /*#__PURE__*/_jsx(InfoTipButton, {
+    active: !isTipHidden,
+    "aria-expanded": !isTipHidden,
+    emphasis: emphasis,
+    ref: buttonRef,
+    onClick: clickHandler
+  }), [isTipHidden, emphasis, clickHandler]);
+
+  /*
+   * For floating placement, screenreader text comes before button to maintain
+   * correct DOM order despite Portal rendering. See GMT-64 for planned fix.
+   */
   return /*#__PURE__*/_jsx(Tip, {
     ...tipProps,
     type: "info",
-    children: /*#__PURE__*/_jsx(InfoTipButton, {
-      active: !isTipHidden,
-      "aria-expanded": !isTipHidden,
-      "aria-label": ariaLabel,
-      "aria-labelledby": ariaLabelledby,
-      "aria-roledescription": ariaRoleDescription,
-      emphasis: emphasis,
-      ref: buttonRef,
-      onClick: clickHandler
+    children: isFloating && alignment.includes('top') ? /*#__PURE__*/_jsxs(_Fragment, {
+      children: [screenreaderText, button]
+    }) : /*#__PURE__*/_jsxs(_Fragment, {
+      children: [button, screenreaderText]
     })
   });
 };

package/dist/Tip/__tests__/helpers.d.ts

@@ -2,9 +2,10 @@
 /// <reference types="testing-library__jest-dom" />
 import { setupRtl } from '@codecademy/gamut-tests';
 import { RefObject } from 'react';
-import { InfoTip } from '../InfoTip';
+import { InfoTip, InfoTipProps } from '../InfoTip';
 import { TipPlacements } from '../shared/types';
 type InfoTipView = ReturnType<ReturnType<typeof setupRtl<typeof InfoTip>>>['view'];
+type Placement = NonNullable<InfoTipProps['placement']>;
 type ViewParam = {
     view: InfoTipView;
 };
@@ -15,7 +16,7 @@ type InfoParam = {
     info: string;
 };
 type PlacementParam = {
-    placement: TipPlacements;
+    placement: Placement;
 };
 export declare const createFocusOnClick: (ref: RefObject<HTMLDivElement>) => ({ isTipHidden }: {
     isTipHidden: boolean;
@@ -47,10 +48,13 @@ export declare const pressKey: (key: string) => Promise<void>;
 export declare const waitForLinkToHaveFocus: ({ view, linkText, }: ViewParam & LinkTextParam) => Promise<HTMLElement>;
 export declare const openTipAndWaitForLink: ({ view, linkText, }: ViewParam & LinkTextParam) => Promise<HTMLElement>;
 export declare const openTipTabToLinkAndWaitForFocus: (view: InfoTipView, linkText: string) => Promise<HTMLElement>;
-export declare const testFocusWrap: ({ view, direction, }: ViewParam & {
+export declare const testShowTipOnClick: ({ view, info, placement, }: ViewParam & InfoParam & PlacementParam) => Promise<void>;
+export declare const testEscapeKeyReturnsFocus: ({ view, info, placement, }: ViewParam & InfoParam & PlacementParam) => Promise<void>;
+export declare const testFocusWrap: ({ view, containerRef, direction, }: ViewParam & {
+    containerRef: RefObject<HTMLDivElement>;
     direction: 'forward' | 'backward';
 }) => Promise<void>;
-export declare const testTabFromPopoverWithNoInteractiveElements: (view: InfoTipView) => Promise<void>;
+export declare const getTipContent: (view: InfoTipView, text: string, useQuery?: boolean) => HTMLElement;
 export declare const testTabbingBetweenLinks: ({ view, firstLinkText, secondLinkText, placement, }: ViewParam & {
     firstLinkText: string;
     secondLinkText: string;
@@ -58,6 +62,7 @@ export declare const testTabbingBetweenLinks: ({ view, firstLinkText, secondLink
 }) => Promise<void>;
 export declare const setupLinkTestWithPlacement: (linkText: string, placement: TipPlacements, renderView: ReturnType<typeof setupRtl<typeof InfoTip>>) => {
     view: import("@testing-library/react").RenderResult;
+    containerRef: RefObject<HTMLDivElement>;
     info: import("react/jsx-runtime").JSX.Element;
     onClick: ({ isTipHidden }: {
         isTipHidden: boolean;
@@ -81,12 +86,28 @@ type ViewWithQueries = {
     getAllByText: (text: string) => HTMLElement[];
     getAllByLabelText: (text: string) => HTMLElement[];
 };
+export declare const getVisibleTip: ({ text, placement, }: {
+    text: string;
+    placement?: "inline" | "floating" | undefined;
+}) => HTMLElement | undefined;
+export declare const expectTipToBeVisible: ({ text, placement, }: {
+    text: string;
+    placement?: "inline" | "floating" | undefined;
+}) => void;
+export declare const expectTipToBeClosed: ({ text, placement, }: {
+    text: string;
+    placement?: "inline" | "floating" | undefined;
+}) => void;
 export declare const openInfoTipsWithKeyboard: ({ view, count, }: {
     view: ViewWithQueries;
     count: number;
 }) => Promise<void>;
 export declare const expectTipsVisible: (tips: {
     text: string;
+    placement?: 'inline' | 'floating';
+}[]) => void;
+export declare const expectTipsClosed: (tips: {
+    text: string;
+    placement?: 'inline' | 'floating';
 }[]) => void;
-export declare const expectTipsClosed: () => void;
 export {};

package/dist/Tip/shared/FloatingTip.js

@@ -18,7 +18,7 @@ export const FloatingTip = ({
   loading,
   narrow,
   overline,
-  contentRef,
+  popoverContentRef,
   truncateLines,
   type,
   username,
@@ -123,7 +123,7 @@ export const FloatingTip = ({
       width: inheritDims ? 'inherit' : undefined,
       onBlur: toolOnlyEventFunc,
       onFocus: toolOnlyEventFunc,
-      onKeyDown: escapeKeyPressHandler,
+      onKeyDown: escapeKeyPressHandler ? e => escapeKeyPressHandler(e) : undefined,
       onMouseDown: e => e.preventDefault(),
       onMouseEnter: toolOnlyEventFunc,
       children: children
@@ -134,7 +134,7 @@ export const FloatingTip = ({
       horizontalOffset: offset,
       isOpen: isPopoverOpen,
       outline: true,
-      popoverContainerRef: contentRef,
+      popoverContainerRef: popoverContentRef,
       skipFocusTrap: true,
       targetRef: ref,
       variant: "secondary",

package/dist/Tip/shared/InlineTip.js

@@ -17,7 +17,6 @@ export const InlineTip = ({
   loading,
   narrow,
   overline,
-  contentRef,
   truncateLines,
   type,
   username,
@@ -43,7 +42,7 @@ export const InlineTip = ({
     height: inheritDims ? 'inherit' : undefined,
     ref: wrapperRef,
     width: inheritDims ? 'inherit' : undefined,
-    onKeyDown: escapeKeyPressHandler,
+    onKeyDown: escapeKeyPressHandler ? e => escapeKeyPressHandler(e) : undefined,
     children: children
   });
   const tipBody = /*#__PURE__*/_jsx(InlineTipBodyWrapper, {
@@ -56,9 +55,7 @@ export const InlineTip = ({
       color: "currentColor",
       horizNarrow: narrow && isHorizontalCenter,
       id: id,
-      ref: contentRef,
       role: type === 'tool' ? 'tooltip' : undefined,
-      tabIndex: type === 'info' ? -1 : undefined,
       width: narrow && !isHorizontalCenter ? narrowWidth : 'max-content',
       zIndex: "auto",
       children: type === 'preview' ? /*#__PURE__*/_jsxs(_Fragment, {

package/dist/Tip/shared/types.d.ts

@@ -46,7 +46,7 @@ export type TipPlacementComponentProps = Omit<TipNewBaseProps, 'placement' | 'em
     escapeKeyPressHandler?: (event: React.KeyboardEvent<HTMLDivElement>) => void;
     id?: string;
     isTipHidden?: boolean;
-    contentRef?: React.RefObject<HTMLDivElement> | ((node: HTMLDivElement | null) => void);
+    popoverContentRef?: React.RefObject<HTMLDivElement> | ((node: HTMLDivElement | null) => void);
     type: 'info' | 'tool' | 'preview';
     wrapperRef?: React.RefObject<HTMLDivElement>;
     zIndex?: number;

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './Anchor';
 export * from './Animation';
 export * from './AppWrapper';
 export * from './Badge';
+export * from './BarChart';
 export * from './BodyPortal';
 export * from './Box';
 export * from './Breadcrumbs';

package/dist/index.js

@@ -6,6 +6,7 @@ export * from './Anchor';
 export * from './Animation';
 export * from './AppWrapper';
 export * from './Badge';
+export * from './BarChart';
 export * from './BodyPortal';
 export * from './Box';
 export * from './Breadcrumbs';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/gamut",
   "description": "Styleguide & Component library for Codecademy",
-  "version": "67.6.1-alpha.1bf8a5.0",
+  "version": "67.6.1-alpha.74920d.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "dependencies": {
     "@codecademy/gamut-icons": "9.53.0",
@@ -56,5 +56,5 @@
     "dist/**/[A-Z]**/[A-Z]*.js",
     "dist/**/[A-Z]**/index.js"
   ],
-  "gitHead": "3ea4041455bf67ec353aae224820db1d8068fafc"
+  "gitHead": "784e7c9064d61b233dbba456f90e5973546f5434"
 }