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

package/src/Button/IconButton.tsx

@@ -1,59 +0,0 @@
-/*
- * 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, className, ...rest },
-  ref
-) => {
-  if (!title) {
-    console.error("Please make sure to specify a 'title' prop to your IconButton component! ");
-  }
-
-  const iconButtonClasses = [
-    classes["icon-button"],
-    classes[variant],
-    classes[color],
-    classes["button-" + iconSize]
-  ];
-
-  if (className) {
-    iconButtonClasses.push(className);
-  }
-
-  return (
-    <BaseButton {...rest} ref={ref} className={iconButtonClasses.join(" ")}>
-      <Fragment>
-        {children}
-        <span className={readyclasses["sr-only"]}>{title}</span>
-      </Fragment>
-    </BaseButton>
-  );
-};
-
-export const IconButton = React.forwardRef(IconButtonComponent);

package/src/ContextMenu/ContextMenu.test.tsx

@@ -1,314 +0,0 @@
-/*
- * 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, { useEffect, useRef } from "react";
-import { ContextMenu, Props } from "./ContextMenu";
-import { render } from "@testing-library/react";
-import { Button } from "../Button/Button";
-import { ContextMenuItem } from "./ContextMenuItem";
-import userEvent from "@testing-library/user-event";
-
-const onShow = jest.fn();
-const onClick = jest.fn();
-
-const defaultParams: Props = {
-  id: "example-contextmenu",
-  trigger: <Button data-testid="trigger">Click me for a context menu</Button>,
-  children: [
-    <ContextMenuItem onClick={onClick} data-testid="contextmenuitem" key="1">
-      Example item 1
-    </ContextMenuItem>,
-    <ContextMenuItem onClick={onClick} data-testid="contextmenuitem2" key="2">
-      Example item 2
-    </ContextMenuItem>,
-    <ContextMenuItem onClick={onClick} data-testid="contextmenuitem3" key="3">
-      Example item 3
-    </ContextMenuItem>
-  ],
-  show: false,
-  onShow: onShow
-};
-
-const createContextMenu = (params?: (defaultParams: Props) => Props) => {
-  let parameters: Props = defaultParams;
-  if (params) {
-    parameters = params(defaultParams);
-  }
-
-  const queries = render(<ContextMenu {...parameters} data-testid="contextmenu"></ContextMenu>);
-
-  const contextmenu = queries.getByTestId("contextmenu");
-  const trigger = queries.getByTestId("trigger");
-
-  return {
-    ...queries,
-    contextmenu,
-    trigger
-  };
-};
-
-describe("ContextMenu should render", () => {
-  it("renders without crashing", () => {
-    const { contextmenu } = createContextMenu();
-
-    expect(contextmenu).toBeTruthy();
-  });
-
-  it("executed onShow function", () => {
-    const { trigger } = createContextMenu();
-
-    userEvent.click(trigger);
-
-    expect(onShow).toHaveBeenCalled();
-  });
-
-  it("executed onShow function", () => {
-    const { getByTestId } = createContextMenu(defaultParams => ({
-      ...defaultParams,
-      show: true
-    }));
-
-    const button = getByTestId("contextmenuitem");
-
-    userEvent.click(button);
-
-    expect(onClick).toHaveBeenCalled();
-  });
-
-  it("passes custom class to ContextMenuItem", () => {
-    const { getByRole } = createContextMenu(defaultParams => ({
-      ...defaultParams,
-      show: true,
-      children: [
-        <ContextMenuItem data-testid="contextmenuitem" key="1" className="custom">
-          Item 1
-        </ContextMenuItem>
-      ]
-    }));
-
-    const child = getByRole("menuitem");
-
-    expect(child.parentElement).toHaveClass("custom");
-  });
-
-  it("renders the decorative element", () => {
-    const { getByText } = createContextMenu(defaultParams => ({
-      ...defaultParams,
-      show: true,
-      decorativeElement: <div>test</div>
-    }));
-
-    expect(getByText("test")).toBeInTheDocument();
-  });
-
-  it("should throw an error", () => {
-    // Prevent throwing an error in the console when this test is executed. We fix this and the end of this test.
-    const err = console.error;
-    console.error = jest.fn();
-
-    let actual;
-
-    try {
-      // @ts-ignore: mandatory props (test for non-typescript react projects)
-      render(<ContextMenu />);
-    } catch (e: any) {
-      actual = e.message;
-    }
-
-    const expected = "You need to provide an ID to the context menu";
-
-    expect(actual).toEqual(expected);
-
-    console.error = err;
-  });
-});
-
-describe("ref should work", () => {
-  it("should give back the proper data prop, this also checks if the component propagates ...rest properly", () => {
-    const ExampleComponent = ({
-      propagateRef
-    }: {
-      propagateRef?: (ref: React.RefObject<HTMLElement>) => void;
-    }) => {
-      const ref = useRef(null);
-
-      useEffect(() => {
-        if (ref.current) {
-          propagateRef && propagateRef(ref);
-        }
-      }, [ref]);
-
-      return <ContextMenu {...defaultParams} data-ref="testing" ref={ref} />;
-    };
-
-    const refCheck = (ref: React.RefObject<HTMLElement>) => {
-      expect(ref.current).toHaveAttribute("data-ref", "testing");
-    };
-
-    render(<ExampleComponent propagateRef={refCheck} />);
-  });
-});
-
-describe("accessibility controls", () => {
-  it("opening works correctly with arrow key down, then navigation should work with arrow keys", () => {
-    const { getByTestId, trigger } = createContextMenu();
-    const firstContextMenuItem = getByTestId("contextmenuitem");
-    const secondContextMenuItem = getByTestId("contextmenuitem2");
-    const thirdContextMenuItem = getByTestId("contextmenuitem3");
-
-    userEvent.tab();
-    userEvent.keyboard("{arrowdown}");
-    userEvent.keyboard("{arrowdown}");
-    expect(trigger).toHaveAttribute("aria-expanded", "true");
-    expect(firstContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{arrowdown}");
-    expect(secondContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{arrowdown}");
-    expect(thirdContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{arrowdown}");
-    expect(firstContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{arrowup}");
-    expect(thirdContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{arrowup}");
-    expect(secondContextMenuItem).toHaveFocus();
-  });
-
-  it("opens correctly with enter key, closing works with escape key.", async () => {
-    const { trigger } = createContextMenu();
-
-    userEvent.tab();
-    userEvent.keyboard("{enter}");
-
-    expect(trigger).toHaveAttribute("aria-expanded", "true");
-
-    userEvent.keyboard("{escape}");
-
-    expect(trigger).toHaveAttribute("aria-expanded", "false");
-  });
-
-  it("opens correctly with space, home and end buttons work", () => {
-    const { trigger, getByTestId } = createContextMenu();
-    const firstContextMenuItem = getByTestId("contextmenuitem");
-    const thirdContextMenuItem = getByTestId("contextmenuitem3");
-
-    userEvent.tab();
-    userEvent.keyboard("{space}");
-
-    expect(trigger).toHaveAttribute("aria-expanded", "true");
-
-    userEvent.keyboard("{end}");
-
-    expect(thirdContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{home}");
-
-    expect(firstContextMenuItem).toHaveFocus();
-  });
-
-  it("opens correctly with space, navigate with arrow keys, select with enter", () => {
-    onClick.mockImplementation(e => {
-      expect(e.target.getAttribute("data-testid")).toBe("contextmenuitem3");
-    });
-
-    const { trigger, getByTestId } = createContextMenu(defaultParams => ({
-      ...defaultParams
-    }));
-    const thirdContextMenuItem = getByTestId("contextmenuitem3");
-
-    userEvent.tab();
-    userEvent.keyboard("{space}");
-
-    expect(trigger).toHaveAttribute("aria-expanded", "true");
-
-    userEvent.keyboard("{arrowdown}");
-    userEvent.keyboard("{arrowdown}");
-    userEvent.keyboard("{arrowdown}");
-
-    expect(thirdContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{enter}");
-
-    expect(onClick).toHaveBeenCalled();
-  });
-
-  it("opens correctly with enter, navigate with arrow keys, select with space", () => {
-    onClick.mockImplementation(e => {
-      expect(e.target.getAttribute("data-testid")).toBe("contextmenuitem3");
-    });
-
-    const { trigger, getByTestId } = createContextMenu(defaultParams => ({
-      ...defaultParams
-    }));
-    const thirdContextMenuItem = getByTestId("contextmenuitem3");
-
-    userEvent.tab();
-    userEvent.keyboard("{enter}");
-
-    expect(trigger).toHaveAttribute("aria-expanded", "true");
-
-    userEvent.keyboard("{arrowdown}");
-    userEvent.keyboard("{arrowdown}");
-    userEvent.keyboard("{arrowdown}");
-
-    expect(thirdContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{space}");
-
-    expect(onClick).toHaveBeenCalled();
-
-    userEvent.keyboard("{space}");
-
-    expect(thirdContextMenuItem).toHaveFocus();
-  });
-
-  it("opens correctly with enter, navigate with arrow keys skipping the decorative element", () => {
-    onClick.mockImplementation(e => {
-      expect(e.target.getAttribute("data-testid")).toBe("contextmenuitem3");
-    });
-
-    const { trigger, getByTestId, getByText } = createContextMenu(defaultParams => ({
-      ...defaultParams,
-      decorativeElement: <div>test</div>
-    }));
-    const thirdContextMenuItem = getByTestId("contextmenuitem3");
-
-    userEvent.tab();
-    userEvent.keyboard("{enter}");
-
-    expect(getByText("test")).toBeInTheDocument();
-
-    expect(trigger).toHaveAttribute("aria-expanded", "true");
-
-    userEvent.keyboard("{arrowdown}");
-    userEvent.keyboard("{arrowdown}");
-    userEvent.keyboard("{arrowdown}");
-
-    expect(thirdContextMenuItem).toHaveFocus();
-
-    userEvent.keyboard("{space}");
-
-    expect(onClick).toHaveBeenCalled();
-
-    userEvent.keyboard("{space}");
-
-    expect(thirdContextMenuItem).toHaveFocus();
-  });
-});

package/src/ContextMenu/ContextMenu.tsx

@@ -1,248 +0,0 @@
-/*
- * 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 && 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
-      })
-    );
-
-  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/ContextMenu/ContextMenuItem.tsx

@@ -1,88 +0,0 @@
-/*
- * 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 && onClick(event);
-          onSelectedChange && childIndex && onSelectedChange(childIndex);
-        }}
-      >
-        {children}
-      </button>
-    </li>
-  );
-};
-
-export const ContextMenuItem = React.forwardRef(ContextMenuItemComponent);