@onewelcome/react-lib-components 2.0.0-alpha → 2.0.0-alpha.1

package/src/components/ContextMenu/ContextMenu.tsx

@@ -0,0 +1,248 @@
+/*
+ * Copyright 2022 OneWelcome B.V.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+import React, {
+  ComponentPropsWithRef,
+  createRef,
+  ForwardRefRenderFunction,
+  ReactElement,
+  ReactNode,
+  RefObject,
+  useCallback,
+  useEffect,
+  useRef,
+  useState
+} from "react";
+import { Props as ButtonProps } from "../Button/Button";
+import { Props as IconButtonProps } from "../Button/IconButton";
+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";
+import { createPortal } from "react-dom";
+import { useGetDomRoot } from "../../hooks/useGetDomRoot";
+
+export interface Props extends ComponentPropsWithRef<"div"> {
+  trigger: ReactElement<ButtonProps> | ReactElement<IconButtonProps>;
+  decorativeElement?: ReactNode;
+  children: ReactNode;
+  placement?: Placement;
+  transformOrigin?: Placement;
+  offset?: Offset;
+  debounceAmount?: number;
+  id: string;
+  show?: boolean;
+  domRoot?: HTMLElement;
+  onShow?: () => void;
+  onClose?: () => void;
+  popoverProps?: PopoverProps;
+}
+
+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,
+    popoverProps,
+    ...rest
+  }: Props,
+  ref
+) => {
+  const anchorEl = useRef<HTMLButtonElement>(null);
+  const wrappingDivRef = (ref as RefObject<HTMLDivElement>) || createRef<HTMLDivElement>();
+  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));
+
+  const { root } = useGetDomRoot(domRoot, wrappingDivRef);
+
+  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 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);
+        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?.();
+    } else {
+      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
+      })
+    );
+
+  const onOutOfViewHandler = useCallback(() => {
+    setShowContextMenu(false);
+  }, []);
+
+  if (!root) {
+    return null;
+  }
+
+  return (
+    <div
+      {...rest}
+      ref={wrappingDivRef}
+      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"
+          >
+            {renderChildren()}
+          </ul>
+        </Popover>,
+        root
+      )}
+    </div>
+  );
+};
+
+export const ContextMenu = React.forwardRef(ContextMenuComponent);

package/src/components/ContextMenu/ContextMenuItem.tsx

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2022 OneWelcome B.V.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+import React, {
+  ComponentPropsWithRef,
+  createRef,
+  ForwardRefRenderFunction,
+  RefObject,
+  useEffect
+} from "react";
+import classes from "./ContextMenuItem.module.scss";
+
+export interface Props extends Omit<ComponentPropsWithRef<"button">, "onClick"> {
+  children?: string;
+  hasFocus?: boolean;
+  isSelected?: boolean;
+  childIndex?: number;
+  shouldClick?: boolean;
+  contextMenuOpened?: boolean;
+  onClick?: (event: React.MouseEvent<HTMLButtonElement>) => void;
+  onFocusChange?: (childIndex: number) => void;
+  onSelectedChange?: (childIndex: number) => void;
+}
+
+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 (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?.(event);
+          onSelectedChange && childIndex && onSelectedChange(childIndex);
+        }}
+      >
+        {children}
+      </button>
+    </li>
+  );
+};
+
+export const ContextMenuItem = React.forwardRef(ContextMenuItemComponent);