@onewelcome/react-lib-components 6.4.4 → 6.6.0

package/src/components/Form/Select/MultiSelect/MultiSelect.tsx

@@ -17,28 +17,35 @@
 import classes from "./MultiSelect.module.scss";
 
 import React, {
-  createRef,
   ForwardRefRenderFunction,
   Fragment,
   ReactElement,
+  createRef,
   useEffect,
   useRef,
   useState
 } from "react";
-import { Icon, Icons } from "../../../Icon/Icon";
 import { useBodyClick } from "../../../../hooks/useBodyClick";
-import readyclasses from "../../../../readyclasses.module.scss";
-import { filterProps } from "../../../../util/helper";
-import { useArrowNavigation, useSelectPositionList } from "../SelectService";
 import { useDetermineStatusIcon } from "../../../../hooks/useDetermineStatusIcon";
-import { SelectedOptions, Display } from "./SelectedOptions";
-import { SelectButton } from "./SelectButton";
+import readyclasses from "../../../../readyclasses.module.scss";
+import { escapeRegExp, filterProps, generateID } from "../../../../util/helper";
+import { Icon, Icons } from "../../../Icon/Icon";
 import { MultiSelectProps } from "../Select.interfaces";
-import { useSearch } from "../useSearch";
 import { useAddNewBtn } from "../useAddNewBtn";
+import { useSelectPositionList } from "../useSelectPositionList";
+import { SelectButton } from "./SelectButton";
+import { Display, SelectedOptions } from "./SelectedOptions";
+import { useArrowNavigation } from "./useArrowNavigation";
+import { useSearch } from "./useSearch";
+
+const getOptionId = (multiSelectId: string, optionIndex: number) =>
+  `${multiSelectId}_option${optionIndex}`;
+
+const getListboxId = (multiSelectId: string) => `${multiSelectId}_listbox`;
 
 const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSelectProps> = (
   {
+    id,
     children,
     name,
     disabled = false,
@@ -56,42 +63,51 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
     noResultsLabel = "No results found",
     onChange,
     addNew,
-    search,
+    search = { enabled: true, renderThreshold: 0 },
     ...rest
   }: MultiSelectProps,
   ref
 ) => {
+  const multiSelectId = useRef(id ?? generateID(20));
   const [expanded, setExpanded] = useState(false);
-  const [display, setDisplay] = useState<Record<string, Display>>({});
+  const [display, setDisplay] = useState<Display[]>([]);
   const containerReference = useRef<HTMLDivElement>(null);
   const optionListReference = useRef<HTMLDivElement>(null);
-  const [focusedSelectItem, setFocusedSelectItem] = useState(-1);
+  const [focusedSelectItem, setFocusedSelectItem] = useState(0);
   const [shouldClick, setShouldClick] =
     useState(
       false
     ); /** We need this, because whenever we use the arrow keys to select the select item, and we focus the currently selected item it fires the "click" listener in Option 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 [shouldFocusButtonAfterClose, setShouldFocusButtonAfterClose] = useState(false);
-  const optionsVisibleCount = React.Children.count(children) - Object.keys(display).length;
-  const {
-    filter,
-    isSearching,
-    renderSearch,
-    searchInputRef,
-    setIsSearching,
-    searchThreshold,
-    searchVisible
-  } = useSearch({
+  const [optionsVisibleCount, setOptionsVisibleCount] = useState(
+    React.Children.count(children) - display.length
+  );
+  const { filter, renderSearch, searchInputRef, resetSearchState, searchVisible } = useSearch({
+    selectId: multiSelectId.current,
     expanded,
     search,
     searchInputClassName: classes["select-search"],
     optionsCount: optionsVisibleCount,
+    focusedSelectItem,
     setFocusedSelectItem,
     searchInputProps,
-    searchPlaceholder
+    searchPlaceholder,
+    describedBy,
+    getOptionId,
+    getListboxId
   });
   const { addBtnRef, addNewBtnOptionsContainerClassName, renderAddNew } = useAddNewBtn({
+    id: getOptionId(multiSelectId.current, optionsVisibleCount),
     addNew,
-    filter
+    filter,
+    focusedSelectItem,
+    optionsCount: optionsVisibleCount,
+    searchInputRef,
+    shouldClick,
+    onClickCallback: () => {
+      setShouldClick(false);
+      resetSearchState();
+    }
   });
 
   const nativeSelect = (ref as React.RefObject<HTMLSelectElement>) || createRef();
@@ -110,8 +126,8 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
       });
       nativeSelect.current.dispatchEvent(new Event("change", { bubbles: true }));
     }
-
     setExpanded(false);
+    resetSearchState();
   };
 
   const onSelectedOptionRemoveHandler = (value: string) => {
@@ -126,33 +142,24 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
   const { onArrowNavigation } = useArrowNavigation({
     expanded,
     setExpanded,
-    isSearching,
-    setIsSearching,
     setFocusedSelectItem,
-    onOptionChangeHandler,
     childrenCount: optionsVisibleCount,
     setShouldClick,
-    searchInputRef,
     addBtnRef,
-    renderThreshold: searchThreshold
+    searchInputRef,
+    customSelectButtonRef,
+    onClose: resetSearchState
   });
 
   const { listPosition, opacity, optionsListMaxHeight, setListPosition, setOpacity } =
     useSelectPositionList({ expanded, optionListReference, containerReference, addBtnRef });
 
-  const syncDisplayValue = (vals: string[]) => {
-    const displayArray = React.Children.map(children, child => child).reduce(
-      (prevOption, curOption) => {
-        if (vals.includes(curOption.props.value)) {
-          prevOption[curOption.props.value] = {
-            label: curOption.props.children,
-            fixed: curOption.props.fixed
-          };
-        }
-        return prevOption;
-      },
-      {} as Record<string, Display>
-    );
+  const syncDisplayValue = (values: string[]) => {
+    const options = React.Children.map(children, child => child);
+    const displayArray: Display[] = values.map(value => {
+      const option = options.find(option => option.props.value === value);
+      return { value, label: option?.props.children, fixed: option?.props.fixed };
+    });
     setDisplay(displayArray);
   };
 
@@ -177,31 +184,37 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
     type ReactChildrenType = ReturnType<typeof React.Children.toArray>;
 
     const filterOutSelectedChildren = (internalChildren: ReactChildrenType) => {
-      const selectedValues = Object.keys(display);
       return internalChildren.filter(
         child =>
           typeof child === "object" &&
           "props" in child &&
-          !selectedValues.includes(child.props.value as string)
+          !display.find(option => option.value === child.props.value)
       );
     };
 
-    if (isSearching || filter !== "") {
+    let results;
+    if (filter !== "") {
       const filteredChildren = React.Children.toArray(children).filter(
         child =>
-          (child as ReactElement).props.children.toLowerCase().match(filter.toLowerCase()) !== null
+          (child as ReactElement).props.children
+            .toLowerCase()
+            .match(escapeRegExp(filter.toLowerCase())) !== null
       );
 
-      const internalChildren = _internalRenderChildren(filterOutSelectedChildren(filteredChildren));
+      results = _internalRenderChildren(filterOutSelectedChildren(filteredChildren));
+    } else {
+      results = _internalRenderChildren(
+        filterOutSelectedChildren(React.Children.toArray(children))
+      );
+    }
 
-      if (internalChildren.length === 0) {
-        return <li className={classes["no-results"]}>{noResultsLabel}</li>;
-      }
+    optionsVisibleCount !== results.length && setOptionsVisibleCount(results.length);
 
-      return internalChildren;
+    if (results.length === 0) {
+      return <li className={classes["no-results"]}>{noResultsLabel}</li>;
     }
 
-    return _internalRenderChildren(filterOutSelectedChildren(React.Children.toArray(children)));
+    return results;
 
     function _internalRenderChildren(internalChildren: ReactChildrenType) {
       return React.Children.map(internalChildren, (child, index) => {
@@ -211,13 +224,15 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
           },
           onOptionSelect: (optionRef: React.RefObject<HTMLLIElement>) => {
             onOptionChangeHandler(optionRef.current);
+            setExpanded(false);
             setShouldClick(false);
           },
-          isSearching: isSearching,
+          isSearching: false,
           selectOpened: expanded,
           childIndex: index,
           hasFocus: focusedSelectItem === index,
-          shouldClick: shouldClick
+          shouldClick: shouldClick,
+          id: getOptionId(multiSelectId.current, index)
         });
       });
     }
@@ -238,16 +253,21 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
   };
 
   useEffect(() => {
-    if (expanded) {
-      setFocusedSelectItem(0);
+    if (expanded && searchInputRef.current) {
       setShouldFocusButtonAfterClose(true);
+      searchInputRef.current.focus();
     }
 
     if (!expanded && customSelectButtonRef.current && shouldFocusButtonAfterClose) {
-      customSelectButtonRef.current.focus();
       setShouldFocusButtonAfterClose(false);
+      customSelectButtonRef.current.focus();
     }
-  }, [expanded, customSelectButtonRef.current, shouldFocusButtonAfterClose]);
+  }, [
+    expanded,
+    customSelectButtonRef.current,
+    shouldFocusButtonAfterClose,
+    searchInputRef.current
+  ]);
 
   useEffect(() => {
     syncDisplayValue(value);
@@ -272,7 +292,8 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
   success && additionalClasses.push(classes.success);
 
   const onSelectButtonClick = () => {
-    setExpanded(!expanded);
+    setExpanded(expanded => !expanded);
+    setShouldClick(false);
   };
 
   /** The native select is purely for external form libraries. We use it to emit an onChange with native select event object so they know exactly what's happening. */
@@ -295,16 +316,16 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
       </select>
       <div
         {...filterProps(rest, /^data-/)}
+        id={multiSelectId.current}
         ref={containerReference}
         onKeyDown={onArrowNavigation}
         className={`custom-select ${classes.select} ${additionalClasses.join(" ")} ${
           className ?? ""
         }`}
       >
-        {searchVisible && renderSearch()}
         <div
           className={`${classes["custom-select"]} ${additionalClasses.join(" ")} `}
-          style={{ display: expanded && searchVisible ? "none" : "flex" }}
+          style={{ display: "flex" }}
         >
           <div className={classes["display-container"]} data-display>
             <SelectButton
@@ -331,10 +352,10 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
                 onRemove={onSelectedOptionRemoveHandler}
               />
             )}
+            {searchVisible && renderSearch()}
           </div>
           <div className={classes["status"]}>{icon || renderChevronIcon()}</div>
         </div>
-
         <div
           ref={optionListReference}
           className={`list-wrapper ${classes["list-wrapper"]}`}
@@ -347,8 +368,10 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
           }}
         >
           <ul
+            id={getListboxId(multiSelectId.current)}
             className={addNewBtnOptionsContainerClassName}
             role="listbox"
+            aria-multiselectable="true"
             style={{ maxHeight: optionsListMaxHeight.list }}
           >
             {renderOptions()}

package/src/components/Form/Select/MultiSelect/SelectButton.module.scss

@@ -14,7 +14,7 @@
  *    limitations under the License.
  */
 
-.add-btn {
+.btn {
   position: absolute;
   top: 0;
   left: 0;

package/src/components/Form/Select/MultiSelect/SelectButton.tsx

@@ -26,7 +26,7 @@ const SelectButtonComponent: ForwardRefRenderFunction<HTMLButtonElement, Props>
   return (
     <button
       {...rest}
-      className={classes["add-btn"]}
+      className={classes["btn"]}
       onClick={onClick}
       ref={ref}
       type="button"

package/src/components/Form/Select/MultiSelect/SelectedOptions.tsx

@@ -20,12 +20,13 @@ import { Tag } from "../../../Tag/Tag";
 import classes from "./SelectedOptions.module.scss";
 
 export type Display = {
+  value: string;
   label: string;
   fixed?: boolean;
 };
 
 export interface Props extends ComponentPropsWithRef<"div"> {
-  display: Record<string, Display>;
+  display: Display[];
   onRemove: (value: string) => void;
   disabled: boolean;
 }
@@ -36,9 +37,9 @@ const SelectedOptionsComponent: ForwardRefRenderFunction<HTMLDivElement, Props>
 ) => {
   return (
     <div {...rest} className={classes["options"]} ref={ref}>
-      {Object.entries(display).map(([value, item]) => (
+      {display.map(item => (
         <Tag
-          key={value}
+          key={item.value}
           onClick={(e: React.MouseEvent<HTMLDivElement>) => {
             e.stopPropagation();
           }}
@@ -48,7 +49,7 @@ const SelectedOptionsComponent: ForwardRefRenderFunction<HTMLDivElement, Props>
               ? {
                   onRemove: (e: React.MouseEvent<HTMLButtonElement>) => {
                     e.stopPropagation();
-                    onRemove(value);
+                    onRemove(item.value);
                   },
                   className: classes["remove-btn"]
                 }

package/src/components/Form/Select/MultiSelect/useArrowNavigation.ts

@@ -0,0 +1,128 @@
+/*
+ * 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.
+ */
+
+interface UseArrowNavigationParams {
+  expanded: boolean;
+  setExpanded: React.Dispatch<React.SetStateAction<boolean>>;
+  setFocusedSelectItem: React.Dispatch<React.SetStateAction<number>>;
+  childrenCount: number;
+  setShouldClick: React.Dispatch<React.SetStateAction<boolean>>;
+  addBtnRef: React.RefObject<HTMLButtonElement>;
+  searchInputRef: React.RefObject<HTMLInputElement>;
+  customSelectButtonRef: React.RefObject<HTMLButtonElement>;
+  onClose: () => void;
+}
+
+/** @scope .*/
+export const useArrowNavigation = ({
+  expanded,
+  setExpanded,
+  setFocusedSelectItem,
+  childrenCount,
+  setShouldClick,
+  addBtnRef,
+  searchInputRef,
+  customSelectButtonRef,
+  onClose
+}: UseArrowNavigationParams) => {
+  const onArrowNavigation = (event: React.KeyboardEvent) => {
+    const codesToPreventDefault = ["ArrowDown", "ArrowUp", "Escape", "End", "Home"];
+    const hasAddBtn = !!addBtnRef?.current;
+    const childrenCountWithAddButton = childrenCount + (hasAddBtn ? 1 : 0);
+    const isSearchEvent = event.target === searchInputRef.current;
+    const isSelectButtonEvent = event.target === customSelectButtonRef.current;
+    const isSearchOrSelectButtonEvent = isSelectButtonEvent || isSearchEvent;
+
+    if (expanded) {
+      codesToPreventDefault.push("Tab");
+      codesToPreventDefault.push("Enter");
+    }
+
+    if (!expanded) {
+      codesToPreventDefault.push("Space");
+    }
+
+    if (codesToPreventDefault.includes(event.code) && !event.metaKey) {
+      event.preventDefault();
+    }
+
+    switch (event.code) {
+      case "ArrowDown":
+        if (!expanded) {
+          setExpanded(true);
+          setFocusedSelectItem(0);
+          break;
+        }
+        setFocusedSelectItem(prevState =>
+          prevState + 1 > childrenCountWithAddButton - 1 ? 0 : prevState + 1
+        );
+        break;
+      case "ArrowUp":
+        if (!expanded) {
+          setExpanded(true);
+          setFocusedSelectItem(childrenCountWithAddButton - 1);
+          break;
+        }
+
+        setFocusedSelectItem(prevState =>
+          prevState - 1 < 0 ? childrenCountWithAddButton - 1 : prevState - 1
+        );
+        break;
+      case "Enter":
+        if (expanded) {
+          setShouldClick(true);
+        } else {
+          setFocusedSelectItem(0);
+        }
+        if (isSearchOrSelectButtonEvent) {
+          setExpanded(!expanded);
+        }
+        break;
+      case "Space":
+        if (!expanded) {
+          setExpanded(true);
+          setFocusedSelectItem(0);
+        }
+        break;
+      case "Home":
+        setFocusedSelectItem(0);
+        break;
+      case "Escape":
+        if (expanded) {
+          setExpanded(false);
+          onClose();
+        }
+        break;
+      case "End":
+        setFocusedSelectItem(childrenCount - 1);
+        break;
+      case "ArrowLeft":
+        if (event.metaKey && expanded) {
+          event.preventDefault();
+          setFocusedSelectItem(0);
+        }
+        break;
+      case "ArrowRight":
+        if (event.metaKey && expanded) {
+          event.preventDefault();
+          setFocusedSelectItem(childrenCount - 1);
+        }
+        break;
+    }
+  };
+
+  return { onArrowNavigation };
+};

package/src/components/Form/Select/MultiSelect/useSearch.tsx

@@ -0,0 +1,126 @@
+/*
+ * 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, useState } from "react";
+import { PartialInputProps, SearchProps } from "../Select.interfaces";
+
+interface Props {
+  selectId: string;
+  search?: SearchProps;
+  optionsCount: number;
+  /**
+   * @deprecated
+   */
+  searchPlaceholder?: string;
+  /**
+   * @deprecated
+   */
+  searchInputProps?: PartialInputProps & { reset?: boolean };
+  searchInputClassName: string;
+  expanded: boolean;
+  setFocusedSelectItem: (idx: number) => void;
+  focusedSelectItem: number;
+  describedBy?: string;
+  getOptionId: (multiSelectId: string, optionIndex: number) => string;
+  getListboxId: (multiSelectId: string) => string;
+}
+
+/** @scope .*/
+export const useSearch = ({
+  selectId,
+  search,
+  optionsCount,
+  searchPlaceholder,
+  searchInputProps,
+  searchInputClassName,
+  expanded,
+  setFocusedSelectItem,
+  focusedSelectItem,
+  describedBy,
+  getOptionId,
+  getListboxId
+}: Props) => {
+  const [filter, setFilter] = useState("");
+
+  const DEFAULT_RENDER_THRESHOLD = 0;
+
+  const searchInputRef = useRef<HTMLInputElement>(null);
+
+  const threshold = search?.renderThreshold ?? DEFAULT_RENDER_THRESHOLD;
+  const hasEnoughChildren = optionsCount >= threshold;
+
+  const shouldRenderSearch = () => {
+    if (search?.enabled) {
+      return hasEnoughChildren;
+    }
+
+    if (search) {
+      return search.enabled as boolean;
+    }
+
+    return optionsCount > DEFAULT_RENDER_THRESHOLD;
+  };
+
+  const renderSearch = () => {
+    return (
+      <input
+        {...((search?.searchInputProps as any) ?? searchInputProps ?? {})}
+        ref={searchInputRef}
+        value={filter}
+        onChange={event => setFilter(event.currentTarget.value)}
+        className={[searchInputClassName, searchInputProps?.className].join(" ")}
+        style={{
+          display: expanded ? "block" : "none"
+        }}
+        type="text"
+        name="search-option"
+        placeholder={search?.searchPlaceholder ?? searchPlaceholder}
+        role="combobox"
+        autoComplete="off"
+        autoCorrect="off"
+        spellCheck={false}
+        aria-controls={getListboxId(selectId)}
+        aria-describedby={describedBy}
+        aria-autocomplete="none"
+        aria-expanded={expanded}
+        aria-activedescendant={getOptionId(selectId, focusedSelectItem)}
+        aria-haspopup={true}
+      />
+    );
+  };
+
+  const resetSearchState = () => {
+    setFilter("");
+    setFocusedSelectItem(0);
+  };
+
+  const visible = shouldRenderSearch();
+
+  useEffect(() => {
+    if (search?.searchInputProps?.reset || searchInputProps?.reset) {
+      resetSearchState();
+    }
+  }, [searchInputProps?.reset, search?.searchInputProps?.reset]);
+
+  return {
+    renderSearch,
+    resetSearchState,
+    searchVisible: visible,
+    searchThreshold: threshold,
+    searchInputRef,
+    filter
+  };
+};

package/src/components/Form/Select/Select.interfaces.ts

@@ -31,6 +31,7 @@ export interface AddNewProps {
   label: string;
   onAddNew: (value: string) => void;
   btnProps?: React.ButtonHTMLAttributes<HTMLButtonElement>;
+  alwaysEnabled?: boolean;
 }
 
 export interface SelectProps<V extends string | readonly string[] | undefined>

package/src/components/Form/Select/SingleSelect/Option.tsx

@@ -20,15 +20,18 @@ import React, {
   createRef,
   RefObject,
   useEffect,
-  ReactNode
+  ReactNode,
+  useRef
 } from "react";
 import classes from "./Select.module.scss";
+import { generateID } from "../../../../util/helper";
 
 export interface Props extends ComponentPropsWithRef<"li"> {
   children: ReactNode;
   value: string;
   disabled?: boolean;
   isSelected?: boolean;
+  disableDefaultSelectedStyle?: boolean;
   selectOpened?: boolean;
   hasFocus?: boolean;
   shouldClick?: boolean;
@@ -42,9 +45,11 @@ export interface Props extends ComponentPropsWithRef<"li"> {
 
 const OptionComponent: ForwardRefRenderFunction<HTMLLIElement, Props> = (
   {
+    id,
     children,
     className,
     isSelected = false,
+    disableDefaultSelectedStyle,
     shouldClick,
     hasFocus,
     selectOpened,
@@ -59,8 +64,15 @@ const OptionComponent: ForwardRefRenderFunction<HTMLLIElement, Props> = (
   }: Props,
   ref
 ) => {
+  const defaultOptionId = useRef(generateID(20));
+  const optionId = id ?? defaultOptionId.current;
   let innerOptionRef = (ref as RefObject<HTMLLIElement>) || createRef<HTMLLIElement>();
 
+  const additionalClasses = [];
+  className && additionalClasses.push(className);
+  isSelected && !disableDefaultSelectedStyle && additionalClasses.push(classes["selected-option"]);
+  disabled && additionalClasses.push(classes["disabled"]);
+
   useEffect(() => {
     if (isSelected && innerOptionRef.current && shouldClick) {
       innerOptionRef.current.click();
@@ -79,11 +91,10 @@ const OptionComponent: ForwardRefRenderFunction<HTMLLIElement, Props> = (
   return (
     <li
       {...rest}
+      id={optionId}
       ref={innerOptionRef}
       data-value={value}
-      className={`${isSelected ? classes["selected-option"] : ""} ${
-        disabled ? classes.disabled : ""
-      } ${className ?? ""}`}
+      className={additionalClasses.join(" ")}
       onClick={onSelectHandler}
       onKeyDown={event => {
         if (event.code === "Enter") {