@onewelcome/react-lib-components 1.3.0 → 1.5.0

package/src/ContextMenu/ContextMenu.tsx

@@ -16,15 +16,17 @@
 
 import React, {
   ComponentPropsWithRef,
+  ForwardRefRenderFunction,
   ReactElement,
   ReactNode,
+  useCallback,
   useEffect,
   useRef,
   useState
 } from "react";
 import { Props as ButtonProps } from "../Button/Button";
 import { Props as IconButtonProps } from "../Button/IconButton";
-import { Popover } from "../Popover/Popover";
+import { Popover, Props as PopoverProps } from "../Popover/Popover";
 import { Placement, Offset } from "../hooks/usePosition";
 import classes from "./ContextMenu.module.scss";
 import { useBodyClick } from "../hooks/useBodyClick";
@@ -37,185 +39,195 @@ export interface Props extends ComponentPropsWithRef<"div"> {
   placement?: Placement;
   transformOrigin?: Placement;
   offset?: Offset;
+  debounceAmount?: number;
   id: string;
   show?: boolean;
   domRoot?: HTMLElement;
   onShow?: () => void;
   onClose?: () => void;
+  popoverProps?: PopoverProps;
 }
 
-export const ContextMenu = React.forwardRef<HTMLDivElement, Props>(
-  (
-    {
-      trigger,
-      children,
-      decorativeElement,
-      id,
-      show = false,
-      onShow,
-      onClose,
-      placement = { horizontal: "right", vertical: "top" },
-      offset = { top: 0, bottom: 0, left: 0, right: 0 },
-      transformOrigin = { horizontal: "left", vertical: "top" },
-      domRoot = document.body,
-      ...rest
-    }: Props,
-    ref
-  ) => {
-    const anchorEl = useRef<HTMLButtonElement>(null);
-    const [showContextMenu, setShowContextMenu] = useState(show);
-    const [hasBeenClosed, setHasBeenClosed] = useState(false);
-    const [selectedContextMenuItem, setSelectedContextMenuItem] = useState(-1);
-    const [focusedContextMenuItem, setFocusedContextMenuItem] = useState(-1);
-    const [shouldClick, setShouldClick] =
-      useState(
-        false
-      ); /** We need this, because whenever we use the arrow keys to select the contextmenu item, and we focus the currently selected item it fires the "click" listener in ContextMenuItem component. Instead, we only want this to fire if we press "enter" or "spacebar" so we set this to true whenever that is the case, and back to false when it has been executed. */
-    const [childrenCount] = useState(React.Children.count(children));
-
-    if (!id) {
-      throw new Error("You need to provide an ID to the context menu");
+const ContextMenuComponent: ForwardRefRenderFunction<HTMLDivElement, Props> = (
+  {
+    trigger,
+    children,
+    decorativeElement,
+    id,
+    show = false,
+    onShow,
+    onClose,
+    placement = { horizontal: "right", vertical: "top" },
+    offset = { top: 0, bottom: 0, left: 0, right: 0 },
+    transformOrigin = { horizontal: "left", vertical: "top" },
+    debounceAmount,
+    domRoot = document.body,
+    popoverProps,
+    ...rest
+  }: Props,
+  ref
+) => {
+  const anchorEl = useRef<HTMLButtonElement>(null);
+  const [showContextMenu, setShowContextMenu] = useState(show);
+  const [hasBeenClosed, setHasBeenClosed] = useState(false);
+  const [selectedContextMenuItem, setSelectedContextMenuItem] = useState(-1);
+  const [focusedContextMenuItem, setFocusedContextMenuItem] = useState(-1);
+  const [shouldClick, setShouldClick] =
+    useState(
+      false
+    ); /** We need this, because whenever we use the arrow keys to select the contextmenu item, and we focus the currently selected item it fires the "click" listener in ContextMenuItem component. Instead, we only want this to fire if we press "enter" or "spacebar" so we set this to true whenever that is the case, and back to false when it has been executed. */
+  const [childrenCount] = useState(React.Children.count(children));
+
+  if (!id) {
+    throw new Error("You need to provide an ID to the context menu");
+  }
+
+  const onArrowNavigation = (event: React.KeyboardEvent) => {
+    if (focusedContextMenuItem === -1 && selectedContextMenuItem !== -1) {
+      setFocusedContextMenuItem(selectedContextMenuItem);
     }
 
-    const onArrowNavigation = (event: React.KeyboardEvent) => {
-      if (focusedContextMenuItem === -1 && selectedContextMenuItem !== -1) {
-        setFocusedContextMenuItem(selectedContextMenuItem);
-      }
-
-      const codesToPrevenDefault = [
-        "ArrowDown",
-        "ArrowUp",
-        "ArrowLeft",
-        "ArrowRight",
-        "Enter",
-        "Space",
-        "Escape",
-        "End",
-        "Home"
-      ];
-
-      if (codesToPrevenDefault.includes(event.code)) {
-        event.preventDefault();
-      }
-
-      switch (event.code) {
-        case "ArrowDown":
-          if (!showContextMenu) {
-            setShowContextMenu(true);
-            return;
-          }
-          setFocusedContextMenuItem(prevState => {
-            return prevState + 1 > childrenCount - 1 ? 0 : prevState + 1;
-          });
-          return;
-        case "ArrowUp":
-          setFocusedContextMenuItem(prevState => {
-            return prevState - 1 < 0 ? childrenCount - 1 : prevState - 1;
-          });
-          return;
-        case "Enter":
-        case "Space":
-          if (!showContextMenu) {
-            setShowContextMenu(true);
-            return;
-          }
-
-          setShouldClick(true);
-          setSelectedContextMenuItem(focusedContextMenuItem);
-          setShowContextMenu(false);
-          return;
-        case "Tab":
-        case "Escape":
-          setShowContextMenu(false);
-          return;
-        case "End":
-          setFocusedContextMenuItem(childrenCount - 1);
+    const codesToPrevenDefault = [
+      "ArrowDown",
+      "ArrowUp",
+      "ArrowLeft",
+      "ArrowRight",
+      "Enter",
+      "Space",
+      "Escape",
+      "End",
+      "Home"
+    ];
+
+    if (codesToPrevenDefault.includes(event.code)) {
+      event.preventDefault();
+    }
+
+    switch (event.code) {
+      case "ArrowDown":
+        if (!showContextMenu) {
+          setShowContextMenu(true);
           return;
-        case "Home":
-          setFocusedContextMenuItem(0);
+        }
+        setFocusedContextMenuItem(prevState => {
+          return prevState + 1 > childrenCount - 1 ? 0 : prevState + 1;
+        });
+        return;
+      case "ArrowUp":
+        setFocusedContextMenuItem(prevState => {
+          return prevState - 1 < 0 ? childrenCount - 1 : prevState - 1;
+        });
+        return;
+      case "Enter":
+      case "Space":
+        if (!showContextMenu) {
+          setShowContextMenu(true);
           return;
-      }
-    };
-
-    useBodyClick(
-      event => {
-        return (
-          showContextMenu &&
-          anchorEl.current !== event.target &&
-          anchorEl.current !== (event.target as HTMLElement).parentElement
-        );
-      },
-      () => {
+        }
+
+        setShouldClick(true);
+        setSelectedContextMenuItem(focusedContextMenuItem);
         setShowContextMenu(false);
-      },
-      showContextMenu
+        return;
+      case "Tab":
+      case "Escape":
+        setShowContextMenu(false);
+        return;
+      case "End":
+        setFocusedContextMenuItem(childrenCount - 1);
+        return;
+      case "Home":
+        setFocusedContextMenuItem(0);
+        return;
+    }
+  };
+
+  useBodyClick(
+    event => {
+      return (
+        showContextMenu &&
+        anchorEl.current !== event.target &&
+        anchorEl.current !== (event.target as HTMLElement).parentElement
+      );
+    },
+    () => {
+      setShowContextMenu(false);
+    },
+    showContextMenu
+  );
+
+  useEffect(() => {
+    if (showContextMenu === true) {
+      onShow && onShow();
+    } else {
+      onClose && onClose();
+      !hasBeenClosed && setHasBeenClosed(true);
+      setFocusedContextMenuItem(-1);
+      hasBeenClosed && anchorEl.current && anchorEl.current.focus();
+    }
+  }, [showContextMenu]);
+
+  const renderTrigger = () =>
+    React.cloneElement(trigger, {
+      id: id,
+      "aria-haspopup": "true",
+      "aria-controls": `${id}-menu`,
+      "aria-expanded": showContextMenu,
+      onClick: () => setShowContextMenu(!showContextMenu),
+      tabIndex: 0,
+      ref: anchorEl
+    });
+
+  const renderChildren = () =>
+    React.Children.map(children, (child, index) =>
+      React.cloneElement(child as ReactElement, {
+        onFocusChange: (childIndex: number) => setFocusedContextMenuItem(childIndex),
+        onSelectedChange: (childIndex: number) => {
+          setSelectedContextMenuItem(childIndex);
+          setShouldClick(false);
+        },
+        childIndex: index,
+        hasFocus: focusedContextMenuItem === index,
+        isSelected: selectedContextMenuItem === index,
+        contextMenuOpened: showContextMenu,
+        shouldClick: shouldClick
+      })
     );
 
-    useEffect(() => {
-      if (showContextMenu === true) {
-        onShow && onShow();
-      } else {
-        onClose && onClose();
-        !hasBeenClosed && setHasBeenClosed(true);
-        setFocusedContextMenuItem(-1);
-        hasBeenClosed && anchorEl.current && anchorEl.current.focus();
-      }
-    }, [showContextMenu]);
-
-    const renderTrigger = () =>
-      React.cloneElement(trigger, {
-        id: id,
-        "aria-haspopup": "true",
-        "aria-controls": `${id}-menu`,
-        "aria-expanded": showContextMenu,
-        onClick: () => setShowContextMenu(!showContextMenu),
-        tabIndex: 0,
-        ref: anchorEl
-      });
-
-    const renderChildren = () => {
-      return React.Children.map(children, (child, index) => {
-        return React.cloneElement(child as ReactElement, {
-          onFocusChange: (childIndex: number) => setFocusedContextMenuItem(childIndex),
-          onSelectedChange: (childIndex: number) => {
-            setSelectedContextMenuItem(childIndex);
-            setShouldClick(false);
-          },
-          childIndex: index,
-          hasFocus: focusedContextMenuItem === index,
-          isSelected: selectedContextMenuItem === index,
-          contextMenuOpened: showContextMenu,
-          shouldClick: shouldClick
-        });
-      });
-    };
-
-    return (
-      <div {...rest} ref={ref} onKeyDown={onArrowNavigation} className={classes["context-menu"]}>
-        {renderTrigger()}
-        {createPortal(
-          <Popover
-            placement={placement}
-            transformOrigin={transformOrigin}
-            offset={offset}
-            anchorEl={anchorEl}
-            show={showContextMenu}
+  const onOutOfViewHandler = useCallback(() => {
+    setShowContextMenu(false);
+  }, []);
+
+  return (
+    <div {...rest} ref={ref} onKeyDown={onArrowNavigation} className={classes["context-menu"]}>
+      {renderTrigger()}
+      {createPortal(
+        <Popover
+          {...popoverProps}
+          placement={placement}
+          transformOrigin={transformOrigin}
+          offset={offset}
+          anchorEl={anchorEl}
+          debounceAmount={debounceAmount}
+          show={showContextMenu}
+          onAnchorOutOfView={onOutOfViewHandler}
+        >
+          {decorativeElement && (
+            <div className={classes["decorative-element"]}>{decorativeElement}</div>
+          )}
+          <ul
+            className={`${classes["menu"]} ${decorativeElement ? classes["no-margin-top"] : ""}`}
+            id={`${id}-menu`}
+            aria-describedby={id}
+            role="menu"
           >
-            {decorativeElement && (
-              <div className={classes["decorative-element"]}>{decorativeElement}</div>
-            )}
-            <ul
-              className={`${classes["menu"]} ${decorativeElement ? classes["no-margin-top"] : ""}`}
-              id={`${id}-menu`}
-              aria-describedby={id}
-              role="menu"
-            >
-              {renderChildren()}
-            </ul>
-          </Popover>,
-          domRoot
-        )}
-      </div>
-    );
-  }
-);
+            {renderChildren()}
+          </ul>
+        </Popover>,
+        domRoot
+      )}
+    </div>
+  );
+};
+
+export const ContextMenu = React.forwardRef(ContextMenuComponent);

package/src/ContextMenu/ContextMenuItem.tsx

@@ -14,7 +14,13 @@
  *    limitations under the License.
  */
 
-import React, { ComponentPropsWithRef, createRef, RefObject, useEffect } from "react";
+import React, {
+  ComponentPropsWithRef,
+  createRef,
+  ForwardRefRenderFunction,
+  RefObject,
+  useEffect
+} from "react";
 import classes from "./ContextMenuItem.module.scss";
 
 export interface Props extends Omit<ComponentPropsWithRef<"button">, "onClick"> {
@@ -29,54 +35,54 @@ export interface Props extends Omit<ComponentPropsWithRef<"button">, "onClick">
   onSelectedChange?: (childIndex: number) => void;
 }
 
-export const ContextMenuItem = React.forwardRef<HTMLButtonElement, Props>(
-  (
-    {
-      children,
-      onClick,
-      onFocusChange,
-      onSelectedChange,
-      hasFocus,
-      isSelected,
-      childIndex,
-      contextMenuOpened,
-      shouldClick,
-      className,
-      ...rest
-    }: Props,
-    ref
-  ) => {
-    let innerButtonRef = (ref as RefObject<HTMLButtonElement>) || createRef<HTMLButtonElement>();
+const ContextMenuItemComponent: ForwardRefRenderFunction<HTMLButtonElement, Props> = (
+  {
+    children,
+    onClick,
+    onFocusChange,
+    onSelectedChange,
+    hasFocus,
+    isSelected,
+    childIndex,
+    contextMenuOpened,
+    shouldClick,
+    className,
+    ...rest
+  }: Props,
+  ref
+) => {
+  let innerButtonRef = (ref as RefObject<HTMLButtonElement>) || createRef<HTMLButtonElement>();
 
-    useEffect(() => {
-      if (isSelected && innerButtonRef.current && shouldClick) {
-        innerButtonRef.current.click();
-      }
-    }, [isSelected, shouldClick]);
+  useEffect(() => {
+    if (isSelected && innerButtonRef.current && shouldClick) {
+      innerButtonRef.current.click();
+    }
+  }, [isSelected, shouldClick]);
 
-    useEffect(() => {
-      if (innerButtonRef.current && hasFocus && contextMenuOpened) {
-        onFocusChange && childIndex && onFocusChange(childIndex);
-        innerButtonRef.current.focus();
-      }
-    }, [hasFocus, innerButtonRef, contextMenuOpened]);
+  useEffect(() => {
+    if (innerButtonRef.current && hasFocus && contextMenuOpened) {
+      onFocusChange && childIndex && onFocusChange(childIndex);
+      innerButtonRef.current.focus();
+    }
+  }, [hasFocus, innerButtonRef, contextMenuOpened]);
 
-    return (
-      <li role="none" className={`${classes["context-menu-item"]} ${className ?? ""}`}>
-        <button
-          role="menuitem"
-          {...rest}
-          ref={innerButtonRef}
-          data-focus={hasFocus}
-          tabIndex={-1}
-          onClick={event => {
-            onClick && onClick(event);
-            onSelectedChange && childIndex && onSelectedChange(childIndex);
-          }}
-        >
-          {children}
-        </button>
-      </li>
-    );
-  }
-);
+  return (
+    <li role="none" className={`${classes["context-menu-item"]} ${className ?? ""}`}>
+      <button
+        role="menuitem"
+        {...rest}
+        ref={innerButtonRef}
+        data-focus={hasFocus}
+        tabIndex={-1}
+        onClick={event => {
+          onClick && onClick(event);
+          onSelectedChange && childIndex && onSelectedChange(childIndex);
+        }}
+      >
+        {children}
+      </button>
+    </li>
+  );
+};
+
+export const ContextMenuItem = React.forwardRef(ContextMenuItemComponent);

package/src/DataGrid/DataGrid.tsx

@@ -37,6 +37,7 @@ export interface Props<T> extends Omit<ComponentPropsWithRef<"div">, "children">
     addBtnProps?: ButtonProps;
     columnsBtnProps?: ButtonProps;
     searchBtnProps?: ButtonProps;
+    searchIconBtnProps?: ButtonProps;
   };
   emptyLabel?: string;
   paginationProps?: PaginationProps;

package/src/DataGrid/DataGridActions/DataGridActions.module.scss

@@ -42,7 +42,7 @@
 
 @media only screen and (min-width: 30em) {
   .desktop {
-    display: block;
+    display: flex;
   }
 
   .mobile {

package/src/DataGrid/DataGridActions/DataGridActions.test.tsx

@@ -105,6 +105,7 @@ describe("DataGridActions should render", () => {
     const addBtnProps = { children: "button1", title: "title1" };
     const columnsBtnProps = { children: "button2", title: "title2" };
     const searchBtnProps = { children: "button3", title: "title3" };
+    const searchIconBtnProps = { title: "title4" };
     const { dataGridActions, getAllByRole } = createDataGridActions(params => ({
       ...params,
       enableAddBtn: true,
@@ -112,7 +113,8 @@ describe("DataGridActions should render", () => {
       enableSearchBtn: true,
       addBtnProps,
       columnsBtnProps,
-      searchBtnProps
+      searchBtnProps,
+      searchIconBtnProps
     }));
 
     expect(dataGridActions).toBeDefined();
@@ -125,7 +127,7 @@ describe("DataGridActions should render", () => {
     expect(mobileColumnsBtn).toHaveTextContent(columnsBtnProps.title);
     expect(desktopSearchBtn).toHaveTextContent(searchBtnProps.children);
     expect(desktopSearchBtn).toHaveAttribute("title", searchBtnProps.title);
-    expect(mobileSearchBtn).toHaveTextContent(searchBtnProps.title);
+    expect(mobileSearchBtn).toHaveTextContent(searchIconBtnProps.title);
   });
 });