@onewelcome/react-lib-components 0.1.4-alpha → 0.1.7-alpha

package/src/ContextMenu/ContextMenu.test.tsx

@@ -1,6 +1,6 @@
 import React, { useEffect, useRef } from 'react';
 import { ContextMenu, Props } from './ContextMenu';
-import { render, getByRole } from '@testing-library/react';
+import { render } from '@testing-library/react';
 import { Button } from '../Button/Button';
 import { ContextMenuItem } from './ContextMenuItem';
 import userEvent from '@testing-library/user-event';
@@ -15,8 +15,12 @@ const defaultParams: Props = {
     <ContextMenuItem onClick={onClick} data-testid="contextmenuitem" key="1">
       Example item 1
     </ContextMenuItem>,
-    <ContextMenuItem key="2">Example item 2</ContextMenuItem>,
-    <ContextMenuItem key="3">Example item 3</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,
@@ -61,12 +65,10 @@ describe('ContextMenu should render', () => {
       show: true,
     }));
 
-    const contextmenuitem = getByTestId('contextmenuitem');
-    const button = getByRole(contextmenuitem, 'button');
+    const button = getByTestId('contextmenuitem');
 
     userEvent.click(button);
 
-    expect(contextmenuitem).toBeTruthy();
     expect(onClick).toHaveBeenCalled();
   });
 
@@ -117,3 +119,116 @@ describe('ref should work', () => {
     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.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.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.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.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.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();
+  });
+});

package/src/ContextMenu/ContextMenu.tsx

@@ -1,16 +1,22 @@
-import React, { ComponentPropsWithRef, ReactElement, useEffect, useRef, useState } from 'react';
+import React, {
+  ComponentPropsWithRef,
+  ReactElement,
+  ReactNode,
+  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 { Placement, Offset } from '../hooks/usePosition';
-import { Props as ContextMenuItemProps } from './ContextMenuItem';
 import classes from './ContextMenu.module.scss';
 import { useBodyClick } from '../hooks/useBodyClick';
 import { createPortal } from 'react-dom';
 
 export interface Props extends ComponentPropsWithRef<'div'> {
   trigger: ReactElement<ButtonProps> | ReactElement<IconButtonProps>;
-  children: ReactElement<ContextMenuItemProps> | ReactElement<ContextMenuItemProps>[];
+  children: ReactNode;
   placement?: Placement;
   transformOrigin?: Placement;
   offset?: Offset;
@@ -40,11 +46,63 @@ export const ContextMenu = React.forwardRef<HTMLDivElement, Props>(
   ) => {
     const anchorEl = useRef<HTMLButtonElement>(null);
     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] = 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);
+      }
+
+      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;
@@ -60,6 +118,8 @@ export const ContextMenu = React.forwardRef<HTMLDivElement, Props>(
         onShow && onShow();
       } else {
         onClose && onClose();
+        setFocusedContextMenuItem(-1);
+        anchorEl.current && anchorEl.current.focus();
       }
     }, [showContextMenu]);
 
@@ -68,13 +128,31 @@ export const ContextMenu = React.forwardRef<HTMLDivElement, Props>(
         id: id,
         'aria-haspopup': 'true',
         'aria-controls': `${id}-menu`,
-        'aria-expanded': show,
+        '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} className={classes['context-menu']}>
+      <div {...rest} ref={ref} onKeyDown={onArrowNavigation} className={classes['context-menu']}>
         {renderTrigger()}
         {createPortal(
           <Popover
@@ -85,7 +163,7 @@ export const ContextMenu = React.forwardRef<HTMLDivElement, Props>(
             show={showContextMenu}
           >
             <ul className={classes.menu} id={`${id}-menu`} aria-describedby={id} role="menu">
-              {children}
+              {renderChildren()}
             </ul>
           </Popover>,
           domRoot

package/src/ContextMenu/ContextMenuItem.tsx

@@ -1,15 +1,63 @@
-import React, { HTMLProps } from 'react';
+import React, { ComponentPropsWithRef, createRef, RefObject, useEffect } from 'react';
 import classes from './ContextMenuItem.module.scss';
 
-export interface Props extends Omit<HTMLProps<HTMLLIElement>, 'onClick'> {
+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;
 }
 
-export const ContextMenuItem = ({ children, onClick, ...rest }: Props) => {
-  return (
-    <li {...rest} role="menuitem" className={classes['context-menu-item']}>
-      <button onClick={(event) => onClick && onClick(event)}>{children}</button>
-    </li>
-  );
-};
+export const ContextMenuItem = React.forwardRef<HTMLButtonElement, Props>(
+  (
+    {
+      children,
+      onClick,
+      onFocusChange,
+      onSelectedChange,
+      hasFocus,
+      isSelected,
+      childIndex,
+      contextMenuOpened,
+      shouldClick,
+      ...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="menuitem" className={classes['context-menu-item']}>
+        <button
+          {...rest}
+          ref={innerButtonRef}
+          data-focus={hasFocus}
+          onClick={(event) => {
+            onClick && onClick(event);
+            onSelectedChange && childIndex && onSelectedChange(childIndex);
+          }}
+        >
+          {children}
+        </button>
+      </li>
+    );
+  }
+);

package/src/Form/Checkbox/Checkbox.test.tsx

@@ -1,15 +1,16 @@
 import React, { useEffect, useRef } from 'react';
-import { Checkbox, CheckboxProps as Props } from './Checkbox';
+import { Checkbox, Props } from './Checkbox';
 import { render } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
+import { Toggle } from '../Toggle/Toggle';
 
-const onChangeHandeler = jest.fn();
+const onChangeHandler = jest.fn();
 
 const defaultParams: Props = {
   name: 'Testing',
   children: 'checkbox content',
   helperText: 'example helper',
-  onChange: onChangeHandeler,
+  onChange: onChangeHandler,
 };
 
 const createCheckbox = (params?: (defaultParams: Props) => Props) => {
@@ -83,9 +84,35 @@ describe('Checkbox should have proper attributes', () => {
   });
 
   it('should be disabled', () => {
-    const { checkbox } = createCheckbox((defaultParams) => ({ ...defaultParams, disabled: true }));
+    const onChangeHandler = jest.fn();
+    const { checkbox } = createCheckbox((defaultParams) => ({
+      ...defaultParams,
+      onChange: onChangeHandler,
+      disabled: true,
+    }));
+
+    expect(checkbox).toBeDisabled();
+
+    userEvent.click(checkbox);
+
+    expect(onChangeHandler).not.toHaveBeenCalled();
+  });
+
+  it('nested checkbox should be disabled', () => {
+    const { getByTestId } = createCheckbox((defaultParams) => ({
+      ...defaultParams,
+      indeterminate: false,
+      label: 'test',
+      children: (
+        <Checkbox data-testid="nested-checkbox" name="test" disabled={true}>
+          test
+        </Checkbox>
+      ),
+    }));
+
+    const nestedCheckbox = getByTestId('nested-checkbox');
 
-    expect(checkbox).toHaveAttribute('disabled');
+    expect(nestedCheckbox).toBeDisabled();
   });
 
   it('should have helpertext rendered', () => {
@@ -131,15 +158,124 @@ describe('Checkbox should be interactive', () => {
   it('should call onChange when clicked', () => {
     const { checkbox } = createCheckbox();
 
-    expect(onChangeHandeler).not.toBeCalled();
+    expect(onChangeHandler).not.toBeCalled();
     userEvent.click(checkbox);
-    expect(onChangeHandeler).toBeCalledTimes(1);
+    expect(onChangeHandler).toBeCalledTimes(1);
   });
 
   it('should not call onChange when disabled', () => {
     const { checkbox } = createCheckbox((defaultParams) => ({ ...defaultParams, disabled: true }));
 
     userEvent.click(checkbox);
-    expect(onChangeHandeler).not.toBeCalled();
+    expect(onChangeHandler).not.toBeCalled();
+  });
+});
+
+describe('toggle version', () => {
+  it('should turn into a toggle', () => {
+    const { container } = render(<Toggle name="toggle">Test</Toggle>);
+
+    expect(container.querySelector('[data-toggle]')).toBeInTheDocument();
+  });
+});
+
+describe('missing attributes gets us errors', () => {
+  it('throws an error for missing label prop', () => {
+    // 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)
+      createCheckbox((defaultParams) => ({
+        ...defaultParams,
+        name: 'testing',
+        children: <Checkbox name="test">Test</Checkbox>,
+      }));
+    } catch (e: any) {
+      actual = e.message;
+    }
+
+    const expected =
+      'If you pass Checkboxes as a child component (to create nested checkbox tree) you need to pass a label to the parent checkbox.';
+
+    expect(actual).toEqual(expected);
+
+    console.error = err;
+  });
+
+  it('throws an error for indeterminate prop', () => {
+    // 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)
+      createCheckbox((defaultParams) => ({
+        ...defaultParams,
+        label: 'testing',
+        children: <Checkbox name="test">Test</Checkbox>,
+      }));
+    } catch (e: any) {
+      actual = e.message;
+    }
+
+    const expected =
+      'If you have nested checkboxes you have to manage the indeterminate state by passing a boolean to the `indeterminate` prop.';
+
+    expect(actual).toEqual(expected);
+
+    console.error = err;
+  });
+
+  it('throws an error for incorrect children prop', () => {
+    // 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)
+      createCheckbox((defaultParams) => ({
+        name: undefined,
+      }));
+    } catch (e: any) {
+      actual = e.message;
+    }
+
+    const expected =
+      'Please make sure to pass either a string or more Checkbox components as a child of your Checkbox component.';
+
+    expect(actual).toEqual(expected);
+
+    console.error = err;
+  });
+
+  it('throws an error for missing name prop', () => {
+    // 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)
+      createCheckbox((defaultParams) => ({
+        children: 'test',
+      }));
+    } catch (e: any) {
+      actual = e.message;
+    }
+
+    const expected = "Please pass a 'name' prop to your <Checkbox> component.";
+
+    expect(actual).toEqual(expected);
+
+    console.error = err;
   });
 });

package/src/Form/Checkbox/Checkbox.tsx

@@ -11,7 +11,7 @@ import { FormSelector } from '../form.interfaces';
 
 const isToggle = (children: ReactNode) => (children as ReactElement)?.props?.['data-toggle'];
 
-export interface CheckboxProps extends ComponentPropsWithRef<'input'>, FormSelector {
+export interface Props extends ComponentPropsWithRef<'input'>, FormSelector {
   children: ReactNode;
   label?: string;
   indeterminate?: boolean;
@@ -20,7 +20,7 @@ export interface CheckboxProps extends ComponentPropsWithRef<'input'>, FormSelec
   onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
 }
 
-export const Checkbox = React.forwardRef<HTMLInputElement, CheckboxProps>(
+export const Checkbox = React.forwardRef<HTMLInputElement, Props>(
   (
     {
       children,
@@ -39,7 +39,7 @@ export const Checkbox = React.forwardRef<HTMLInputElement, CheckboxProps>(
       formSelectorWrapperProps,
       onChange,
       ...rest
-    }: CheckboxProps,
+    }: Props,
     ref
   ) => {
     const { errorId, identifier, describedBy } = useFormSelector({
@@ -53,7 +53,7 @@ export const Checkbox = React.forwardRef<HTMLInputElement, CheckboxProps>(
 
     useEffect(() => {
       if (!name) {
-        console.error("Please pass a 'name' prop to your <Checkbox> component.");
+        throw new Error("Please pass a 'name' prop to your <Checkbox> component.");
       }
 
       if (typeof children === 'object' && !isToggle(children) && indeterminate === undefined) {
@@ -83,17 +83,17 @@ export const Checkbox = React.forwardRef<HTMLInputElement, CheckboxProps>(
 
     const renderNestedCheckboxes = () => (
       <ul className={classes['checkbox-list']}>
-        {React.Children.map(children as ReactNode[], (child) => {
+        {React.Children.map(children as ReactElement[], (child) => {
           return (
             <li>
               <Checkbox
-                {...(child as ReactElement).props}
+                {...child.props}
                 parentHelperId={parentHelperId}
                 parentErrorId={parentErrorId}
                 error={error}
-                disabled={disabled ? disabled : (child as CheckboxProps).disabled}
+                disabled={child.props.disabled ? child.props.disabled : disabled}
               >
-                {(child as ReactElement).props.children}
+                {child.props.children}
               </Checkbox>
             </li>
           );