@onewelcome/react-lib-components 0.0.0-experimental-8e3a0fd

package/src/components/Button/IconButton.tsx

@@ -0,0 +1,63 @@
+/*
+ * 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, { ForwardRefRenderFunction, Fragment } from "react";
+import { BaseButton, Props as BaseButtonProps } from "./BaseButton";
+import classes from "./IconButton.module.scss";
+import readyclasses from "../../readyclasses.module.scss";
+
+export interface Props extends BaseButtonProps {
+  children?: React.ReactNode;
+  iconSize?: "s" | "m" | "l";
+  variant?: "text" | "fill" | "outline";
+  className?: string;
+  title?: string;
+}
+
+export const IconButtonComponent: ForwardRefRenderFunction<HTMLButtonElement, Props> = (
+  {
+    children,
+    color = "primary",
+    variant = "text",
+    iconSize = "m",
+    title = "Icon button",
+    className,
+    ...rest
+  },
+  ref
+) => {
+  const iconButtonClasses = [
+    classes["icon-button"],
+    classes[variant],
+    classes[color],
+    classes["button-" + iconSize]
+  ];
+
+  if (className) {
+    iconButtonClasses.push(className);
+  }
+
+  return (
+    <BaseButton {...rest} ref={ref} title={title} className={iconButtonClasses.join(" ")}>
+      <Fragment>
+        {children}
+        <span className={readyclasses["sr-only"]}>{title}</span>
+      </Fragment>
+    </BaseButton>
+  );
+};
+
+export const IconButton = React.forwardRef(IconButtonComponent);

package/src/components/Button/Spinner.tsx

@@ -0,0 +1,33 @@
+/*
+ * 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 from "react";
+
+export const ButtonSpinner: React.FC<React.SVGProps<SVGSVGElement>> = props => (
+  <svg
+    {...props}
+    width="24"
+    height="24"
+    viewBox="0 0 24 24"
+    fill="none"
+    xmlns="http://www.w3.org/2000/svg"
+  >
+    <path
+      d="M24 12C24 13.8937 23.5518 15.7606 22.6921 17.4479C21.8323 19.1352 20.5855 20.5951 19.0534 21.7082C17.5214 22.8213 15.7476 23.556 13.8772 23.8523C12.0068 24.1485 10.0928 23.9979 8.2918 23.4127C6.49076 22.8275 4.85378 21.8243 3.51472 20.4853C2.17565 19.1462 1.17251 17.5092 0.587322 15.7082C0.00212849 13.9072 -0.148504 11.9932 0.14774 10.1228C0.443984 8.25238 1.17869 6.47863 2.2918 4.94658L3.91307 6.1245C2.98585 7.4007 2.37384 8.87823 2.12707 10.4363C1.8803 11.9943 2.00577 13.5887 2.49324 15.0889C2.9807 16.5892 3.81632 17.9528 4.93176 19.0682C6.0472 20.1837 7.4108 21.0193 8.91107 21.5068C10.4113 21.9942 12.0057 22.1197 13.5637 21.8729C15.1218 21.6262 16.5993 21.0141 17.8755 20.0869C19.1517 19.1597 20.1903 17.9436 20.9065 16.5381C21.6227 15.1326 21.996 13.5775 21.996 12H24Z"
+      fill="#5D607E"
+    />
+  </svg>
+);

package/src/components/ContextMenu/ContextMenu.module.scss

@@ -0,0 +1,41 @@
+/*!
+ * 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.
+ */
+
+.context-menu {
+  position: relative;
+  display: inline-block;
+  box-sizing: border-box;
+}
+
+.menu {
+  white-space: nowrap;
+  margin: 0.25rem 0;
+  list-style: none;
+  padding: 0;
+  min-width: 10rem;
+
+  &.no-margin-top {
+    margin: 0 0 0.25rem;
+  }
+
+  button {
+    text-align: left;
+  }
+}
+
+.decorative-element {
+  margin-top: 0.5rem;
+}

package/src/components/ContextMenu/ContextMenu.tsx

@@ -0,0 +1,206 @@
+/*
+ * 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 { useClickOutside } from "../../hooks/useClickOutside";
+import { Props as ContextMenuItemProps } from "./ContextMenuItem";
+import { createPortal } from "react-dom";
+import { useGetDomRoot } from "../../hooks/useGetDomRoot";
+import { useArrowNavigation, useDefaultOffset, useFocusAnchorElement } from "./ContextMenuService";
+import { generateID } from "../../util/helper";
+
+export interface Props extends Omit<ComponentPropsWithRef<"div">, "onChange"> {
+  trigger: ReactElement<ButtonProps> | ReactElement<IconButtonProps>;
+  decorativeElement?: ReactNode;
+  children: ReactElement<ContextMenuItemProps> | ReactElement<ContextMenuItemProps>[];
+  placement?: Placement;
+  transformOrigin?: Placement;
+  offset?: Offset;
+  debounceAmount?: number;
+  id?: string;
+  show?: boolean;
+  domRoot?: HTMLElement;
+  onShow?: () => void;
+  onClose?: () => void;
+  popoverProps?: PopoverProps;
+  value?: number;
+  onChange?: (event: React.MouseEvent<HTMLButtonElement>, childIndex: number) => void;
+}
+
+const ContextMenuComponent: ForwardRefRenderFunction<HTMLDivElement, Props> = (
+  {
+    trigger,
+    children,
+    decorativeElement,
+    id = `ID-${generateID()}`,
+    show = false,
+    onShow,
+    onClose,
+    placement = { horizontal: "right", vertical: "top" },
+    offset,
+    transformOrigin = { horizontal: "left", vertical: "top" },
+    debounceAmount,
+    domRoot,
+    popoverProps,
+    value,
+    onChange,
+    ...rest
+  }: Props,
+  ref
+) => {
+  const anchorEl = useRef<HTMLButtonElement>(null);
+  const wrappingDivRef = (ref as RefObject<HTMLDivElement>) || createRef<HTMLDivElement>();
+  const [showContextMenu, setShowContextMenu] = useState(show);
+  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 = React.Children.count(children);
+
+  const { root } = useGetDomRoot(domRoot, wrappingDivRef);
+
+  const syncSelectedContextMenuItem = setSelectedContextMenuItem;
+
+  useEffect(() => {
+    value !== undefined && syncSelectedContextMenuItem(value);
+  }, [value]);
+
+  const { calculateDefaultOffset } = useDefaultOffset();
+  const calculatedOffset = offset ?? calculateDefaultOffset(placement, transformOrigin);
+
+  const { onArrowNavigation } = useArrowNavigation({
+    selectedContextMenuItem,
+    setSelectedContextMenuItem,
+    focusedContextMenuItem,
+    setFocusedContextMenuItem,
+    showContextMenu,
+    setShowContextMenu,
+    childrenCount,
+    setShouldClick
+  });
+
+  useClickOutside(anchorEl, () => {
+    if (showContextMenu) {
+      setShowContextMenu(false);
+    }
+  }, [showContextMenu]);
+
+  useFocusAnchorElement(
+    anchorEl,
+    id,
+    showContextMenu,
+    setShowContextMenu,
+    setFocusedContextMenuItem,
+    onShow,
+    onClose
+  );
+
+  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: (event: React.MouseEvent<HTMLButtonElement>, childIndex: number) => {
+          setSelectedContextMenuItem(childIndex);
+          setShouldClick(false);
+          onChange?.(event, childIndex);
+        },
+        childIndex: index,
+        hasFocus: focusedContextMenuItem === index,
+        isSelected: selectedContextMenuItem === index,
+        showActiveState:
+          child?.props.showActiveState ??
+          (value !== undefined && selectedContextMenuItem === index),
+        contextMenuOpened: showContextMenu,
+        shouldClick: shouldClick,
+        autoFocus: showContextMenu && index === 0
+      })
+    );
+
+  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={calculatedOffset}
+          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.module.scss

@@ -0,0 +1,73 @@
+/*!
+ * 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.
+ */
+
+@use "../../mixins.module.scss";
+@use "../../variables.scss";
+
+.context-menu-item {
+  position: relative;
+
+  button {
+    background-color: transparent;
+    border: 0;
+    font-family: var(--font-family);
+    font-size: var(--context-menu-font-size);
+    line-height: 1.43;
+    cursor: pointer;
+    width: 100%;
+    height: 100%;
+    padding: 0.62rem 0.75rem;
+    box-sizing: border-box;
+
+    &:focus-visible {
+      outline: none;
+
+      &::after {
+        content: "";
+        position: absolute;
+        top: 0;
+        left: 0;
+        height: 100%;
+        width: 100%;
+        z-index: calc(variables.$popover-z-index + 1);
+        @include mixins.focusVisibleOutline($outlineOffset: 0, $selectors: null);
+      }
+    }
+
+    &:hover {
+      background-color: var(--context-menu-hover-color);
+    }
+
+    &:active {
+      background-color: var(--context-menu-pressed-color);
+    }
+
+    &.active {
+      color: var(--context-menu-active-color);
+
+      &::before {
+        content: "";
+        position: absolute;
+        top: 0;
+        left: 0;
+        height: 100%;
+        border-top-right-radius: 0.125rem;
+        border-bottom-right-radius: 0.125rem;
+        border-left: 0.25rem solid var(--context-menu-active-color);
+      }
+    }
+  }
+}

package/src/components/ContextMenu/ContextMenuItem.tsx

@@ -0,0 +1,100 @@
+/*
+ * 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,
+  ReactNode,
+  RefObject,
+  useEffect
+} from "react";
+import classes from "./ContextMenuItem.module.scss";
+
+export interface Props extends Omit<ComponentPropsWithRef<"button">, "onClick"> {
+  children?: ReactNode;
+  hasFocus?: boolean;
+  isSelected?: boolean;
+  showActiveState?: boolean;
+  childIndex?: number;
+  shouldClick?: boolean;
+  contextMenuOpened?: boolean;
+  autoFocus?: boolean;
+  onClick?: (event: React.MouseEvent<HTMLButtonElement>) => void;
+  onFocusChange?: (childIndex: number) => void;
+  onSelectedChange?: (event: React.MouseEvent<HTMLButtonElement>, childIndex: number) => void;
+}
+
+const ContextMenuItemComponent: ForwardRefRenderFunction<HTMLButtonElement, Props> = (
+  {
+    children,
+    onClick,
+    onFocusChange,
+    onSelectedChange,
+    hasFocus,
+    isSelected,
+    showActiveState,
+    childIndex,
+    contextMenuOpened,
+    shouldClick,
+    autoFocus,
+    className,
+    ...rest
+  }: Props,
+  ref
+) => {
+  const innerButtonRef = (ref as RefObject<HTMLButtonElement>) || createRef<HTMLButtonElement>();
+
+  useEffect(() => {
+    if (isSelected && innerButtonRef.current && shouldClick) {
+      innerButtonRef.current.click();
+    }
+  }, [isSelected, shouldClick]);
+
+  useEffect(() => {
+    if (autoFocus && innerButtonRef.current) {
+      innerButtonRef.current.focus();
+    }
+  }, [autoFocus]);
+
+  useEffect(() => {
+    if (innerButtonRef.current && hasFocus && contextMenuOpened) {
+      onFocusChange && childIndex !== undefined && onFocusChange(childIndex);
+      innerButtonRef.current.focus();
+    }
+  }, [hasFocus, innerButtonRef, contextMenuOpened]);
+
+  return (
+    <li role="none" className={`${classes["context-menu-item"]} ${className ?? ""}`}>
+      <button
+        role="menuitem"
+        className={showActiveState ? classes["active"] : undefined}
+        {...rest}
+        ref={innerButtonRef}
+        data-focus={hasFocus}
+        tabIndex={-1}
+        onClick={event => {
+          onClick?.(event);
+          childIndex !== undefined && onSelectedChange?.(event, childIndex);
+        }}
+      >
+        {children}
+      </button>
+    </li>
+  );
+};
+
+export const ContextMenuItem = React.forwardRef(ContextMenuItemComponent);

package/src/components/ContextMenu/ContextMenuService.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 { SetStateAction, useEffect } from "react";
+import { horizontal, Offset, Placement, vertical } from "../../hooks/usePosition";
+import { remToPx } from "../../util/helper";
+
+interface UseArrowNavigation {
+  selectedContextMenuItem: number;
+  setSelectedContextMenuItem: React.Dispatch<React.SetStateAction<number>>;
+  focusedContextMenuItem: number;
+  setFocusedContextMenuItem: React.Dispatch<React.SetStateAction<number>>;
+  showContextMenu: boolean;
+  setShowContextMenu: React.Dispatch<React.SetStateAction<boolean>>;
+  childrenCount: number;
+  setShouldClick: React.Dispatch<React.SetStateAction<boolean>>;
+}
+
+/** @scope . */
+export const useArrowNavigation = ({
+  selectedContextMenuItem,
+  setSelectedContextMenuItem,
+  focusedContextMenuItem,
+  setFocusedContextMenuItem,
+  showContextMenu,
+  setShowContextMenu,
+  childrenCount,
+  setShouldClick
+}: UseArrowNavigation) => {
+  const onArrowNavigation = (event: React.KeyboardEvent) => {
+    if (focusedContextMenuItem === -1 && selectedContextMenuItem !== -1) {
+      setFocusedContextMenuItem(selectedContextMenuItem);
+    }
+
+    const codesToPreventDefault = [
+      "ArrowDown",
+      "ArrowUp",
+      "ArrowLeft",
+      "ArrowRight",
+      "Enter",
+      "Space",
+      "Escape",
+      "End",
+      "Home"
+    ];
+
+    if (codesToPreventDefault.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;
+    }
+  };
+
+  return { onArrowNavigation };
+};
+
+const defaultOffsetSpacing = remToPx(0.25);
+
+export const useDefaultOffset = () => {
+  const calculateDefaultOffset = (placement: Placement, transformOrigin: Placement): Offset => {
+    const offset = { left: 0, right: 0, top: 0, bottom: 0 };
+    if (placement.vertical === vertical.BOTTOM && transformOrigin.vertical === vertical.TOP) {
+      offset.top = defaultOffsetSpacing;
+    } else if (
+      placement.vertical === vertical.TOP &&
+      transformOrigin.vertical === vertical.BOTTOM
+    ) {
+      offset.top = -defaultOffsetSpacing;
+    }
+
+    if (placement.horizontal === horizontal.RIGHT) {
+      offset.left = defaultOffsetSpacing;
+    }
+    return offset;
+  };
+
+  return { calculateDefaultOffset };
+};
+
+export const useFocusAnchorElement = (
+  anchorEl: React.RefObject<HTMLElement>,
+  id: string,
+  showContextMenu: boolean,
+  setShowContextMenu: React.Dispatch<SetStateAction<boolean>>,
+  setFocusedContextMenuItem: React.Dispatch<SetStateAction<number>>,
+  onShow?: () => void,
+  onClose?: () => void
+) => {
+  const handleEscapeKeyPress = (e: KeyboardEvent) => {
+    if (e.key === "Escape") {
+      setShowContextMenu(false);
+      anchorEl.current?.focus();
+    }
+  };
+
+  const escapeKeyEventHandlerManager = () => {
+    if (showContextMenu) {
+      document.addEventListener("keydown", handleEscapeKeyPress);
+    } else {
+      document.removeEventListener("keydown", handleEscapeKeyPress);
+    }
+  };
+
+  const emitContextMenuEvent = () => {
+    if (showContextMenu) {
+      onShow?.();
+    } else {
+      onClose?.();
+
+      if (document.activeElement?.closest(`#${id}-menu`)) {
+        anchorEl.current?.focus();
+      }
+
+      setFocusedContextMenuItem(-1);
+    }
+  };
+
+  useEffect(() => {
+    escapeKeyEventHandlerManager();
+    emitContextMenuEvent();
+  }, [showContextMenu]);
+};