@onewelcome/react-lib-components 6.1.0 → 6.2.0

package/src/components/Form/Fieldset/Fieldset.tsx

@@ -19,7 +19,8 @@ import readyclasses from "../../../readyclasses.module.scss";
 import classes from "./Fieldset.module.scss";
 import { Typography, Variant } from "../../Typography/Typography";
 import { Input } from "../Input/Input";
-import { Select } from "../Select/Select";
+import { Select } from "../Select/SingleSelect/Select";
+import { MultiSelect } from "../Select/MultiSelect/MultiSelect";
 import { Radio } from "../Radio/Radio";
 import { Checkbox } from "../Checkbox/Checkbox";
 import { Textarea } from "../Textarea/Textarea";
@@ -73,6 +74,7 @@ const FieldsetComponent: ForwardRefRenderFunction<HTMLFieldSetElement, Props> =
     const allowedComponents: React.ComponentPropsWithRef<any>[] = [
       Input,
       Select,
+      MultiSelect,
       Radio,
       Checkbox,
       Textarea,

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

@@ -0,0 +1,31 @@
+/*
+ * 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 } from "react";
+import { Props as SelectOptionProps, Option as SelectOption } from "../SingleSelect/Option";
+
+export interface Props extends SelectOptionProps {
+  fixed?: boolean;
+}
+
+const MultiOptionComponent: ForwardRefRenderFunction<HTMLLIElement, Props> = (
+  { fixed: _fixed, ...rest }: Props,
+  ref
+) => {
+  return <SelectOption ref={ref} {...rest} />;
+};
+
+export const MultiOption = React.forwardRef(MultiOptionComponent);

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

@@ -0,0 +1,244 @@
+/*!
+ * 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 "src/mixins.module";
+@use "src/variables";
+
+$listItemHeight: 2.5rem;
+
+.select {
+  position: relative;
+  box-sizing: border-box;
+  @include mixins.transition(all, 0.2s, ease-in-out);
+  border: 0;
+  border-radius: var(--input-border-radius);
+  background-color: var(--input-background-color);
+  font-size: var(--form-control-font-size);
+
+  [data-display] {
+    color: var(--color-default);
+    font-family: var(--font-family);
+  }
+
+  &.expanded {
+    .list-wrapper {
+      background: var(--light);
+    }
+  }
+
+  &:not(.expanded) {
+    .custom-select:focus:not(.error) {
+      border: var(--input-border-width-focus) solid var(--color-focus);
+      padding: 0
+        calc(variables.$form-element-horizontal-padding-mobile - var(--input-border-width-focus));
+    }
+  }
+
+  &:hover:not(.disabled):not(.expanded):not(.error) {
+    .custom-select:not(:focus) {
+      border-color: var(--default);
+      border-width: var(--input-border-width);
+      background-color: var(--color-blue-grey25);
+    }
+  }
+
+  .custom-select {
+    box-sizing: border-box;
+    width: 100%;
+    min-height: calc(2.625rem - (2 * var(--input-border-width)));
+    padding: 0 calc(variables.$form-element-horizontal-padding-mobile - var(--input-border-width));
+    background-color: transparent;
+    border-color: var(--color-blue-grey500);
+    border-style: var(--input-border-style);
+    border-width: var(--input-border-width);
+    border-radius: var(--input-border-radius);
+    font-size: var(--form-control-font-size);
+    @include mixins.transition(all, 0.2s, ease-in-out);
+
+    &:focus {
+      outline: 0;
+    }
+
+    &.error {
+      border-color: var(--error);
+    }
+
+    &.error:focus {
+      border-width: var(--input-border-width-focus);
+    }
+
+    &.disabled {
+      border-color: var(--color-disabled);
+      pointer-events: none;
+    }
+
+    .display-container {
+      flex: 1;
+      display: flex;
+      align-items: center;
+      padding: 0.1875rem 0;
+    }
+  }
+
+  .list-wrapper {
+    border-color: var(--light-grey-border);
+    border-style: var(--input-border-style);
+    border-width: var(--input-border-width);
+    border-radius: var(--input-border-radius);
+    box-shadow: 0px 4px 5px 0px #01053233;
+    box-shadow: 0px 3px 14px 0px #0105321f;
+    box-shadow: 0px 8px 10px 0px #01053224;
+    position: absolute;
+    z-index: variables.$select-z-index;
+    top: 44px;
+    left: 0;
+    width: 100%;
+    overflow: auto;
+  }
+
+  ul {
+    box-sizing: border-box;
+    padding: 0.25rem 0;
+    width: 100%;
+    margin: 0;
+    list-style: none;
+    background-color: var(--light);
+    border-radius: var(--input-border-radius);
+    color: var(--default);
+    text-align: left;
+    overflow: auto;
+    max-height: calc($listItemHeight * 10);
+
+    li {
+      padding: 0.62rem 0.75rem;
+      font-size: var(--form-control-font-size);
+      margin: 0;
+      position: relative;
+      line-height: 1.25rem;
+      box-sizing: border-box;
+      min-height: $listItemHeight;
+      cursor: pointer;
+
+      &:after {
+        content: "";
+        position: absolute;
+        top: 0;
+        left: 0;
+        background-color: transparent;
+        width: 100%;
+        height: 100%;
+        opacity: 0.05;
+      }
+
+      &:focus {
+        outline: var(--input-border-width-focus) solid var(--color-primary300);
+        outline-offset: -var(--input-border-width-focus);
+      }
+
+      &:hover:after,
+      &:active:after {
+        background-color: var(--color-primary);
+      }
+
+      &:active:after {
+        opacity: 0.1;
+      }
+
+      &.disabled {
+        color: var(--greyed-out);
+        background-color: var(--disabled);
+        pointer-events: none;
+      }
+    }
+  }
+}
+
+.selected-option {
+  &: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(--color-primary);
+  }
+  color: var(--color-primary);
+}
+
+.status {
+  padding: 0.3125rem;
+  display: flex;
+  align-items: center;
+
+  [data-icon-status="success"] {
+    color: var(--success);
+    font-size: 1.25rem;
+  }
+
+  [data-icon-status="error"] {
+    color: var(--error);
+    font-size: 1.25rem;
+  }
+
+  .chevron-icon {
+    color: var(--default);
+    font-size: 0.625rem;
+  }
+
+  * + * {
+    margin-left: 1.25rem;
+  }
+}
+
+.placeholder {
+  color: var(--greyed-out);
+}
+
+.select-search {
+  position: relative;
+  width: 100%;
+  box-sizing: border-box;
+  border-bottom-left-radius: 0;
+  border-bottom-right-radius: 0;
+}
+
+.disabled {
+  cursor: not-allowed;
+  color: var(--greyed-out);
+  background-color: var(--color-blue-grey25);
+
+  > * {
+    pointer-events: none;
+  }
+}
+
+@media only screen and (min-width: 30em) {
+  .select {
+    .custom-select {
+      padding: 0
+        calc(variables.$form-element-horizontal-padding-desktop - var(--input-border-width));
+    }
+
+    &:not(.expanded) {
+      .custom-select:focus:not(.error) {
+        padding: 0
+          calc(variables.$form-element-horizontal-padding-desktop - var(--input-border-width-focus));
+      }
+    }
+  }
+}

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

@@ -0,0 +1,363 @@
+/*
+ * 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 classes from "./MultiSelect.module.scss";
+
+import React, {
+  createRef,
+  ForwardRefRenderFunction,
+  Fragment,
+  ReactElement,
+  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 { MultiSelectProps } from "../Select.interfaces";
+import { useSearch } from "../useSearch";
+import { useAddNewBtn } from "../useAddNewBtn";
+
+const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSelectProps> = (
+  {
+    children,
+    name,
+    disabled = false,
+    labeledBy,
+    placeholder,
+    describedBy,
+    searchPlaceholder = "Search item",
+    searchInputProps,
+    selectButtonProps = {},
+    className,
+    error = false,
+    success = false,
+    value,
+    clearLabel = "Clear selection",
+    noResultsLabel = "No results found",
+    onChange,
+    addNew,
+    search,
+    ...rest
+  }: MultiSelectProps,
+  ref
+) => {
+  const [expanded, setExpanded] = useState(false);
+  const [display, setDisplay] = useState<Record<string, Display>>({});
+  const containerReference = useRef<HTMLDivElement>(null);
+  const optionListReference = useRef<HTMLDivElement>(null);
+  const [focusedSelectItem, setFocusedSelectItem] = useState(-1);
+  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({
+    expanded,
+    search,
+    searchInputClassName: classes["select-search"],
+    optionsCount: optionsVisibleCount,
+    setFocusedSelectItem,
+    searchInputProps,
+    searchPlaceholder
+  });
+  const { addBtnRef, addNewBtnOptionsContainerClassName, renderAddNew } = useAddNewBtn({
+    addNew,
+    filter
+  });
+
+  const nativeSelect = (ref as React.RefObject<HTMLSelectElement>) || createRef();
+
+  const onOptionChangeHandler = (optionElement: HTMLElement | null) => {
+    if (nativeSelect.current && optionElement) {
+      const value = optionElement.getAttribute("data-value")!;
+      const options = [...nativeSelect.current.options];
+      const lastSelectedOptionValues = options
+        .filter(option => option.selected)
+        .map(option => option.value);
+      options.forEach(option => {
+        if (option.value === value || lastSelectedOptionValues.includes(option.value)) {
+          option.selected = true;
+        }
+      });
+      nativeSelect.current.dispatchEvent(new Event("change", { bubbles: true }));
+    }
+
+    setExpanded(false);
+  };
+
+  const onSelectedOptionRemoveHandler = (value: string) => {
+    if (nativeSelect.current) {
+      const options = [...nativeSelect.current.options];
+      options.find(option => option.value === value)!.selected = false;
+      nativeSelect.current.dispatchEvent(new Event("change", { bubbles: true }));
+    }
+  };
+
+  const customSelectButtonRef = useRef<HTMLButtonElement>(null);
+  const { onArrowNavigation } = useArrowNavigation({
+    expanded,
+    setExpanded,
+    isSearching,
+    setIsSearching,
+    setFocusedSelectItem,
+    onOptionChangeHandler,
+    childrenCount: optionsVisibleCount,
+    setShouldClick,
+    searchInputRef,
+    addBtnRef,
+    renderThreshold: searchThreshold
+  });
+
+  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>
+    );
+    setDisplay(displayArray);
+  };
+
+  const syncSelectedOption = (vals: string[]) => {
+    if (nativeSelect.current) {
+      const options = [...nativeSelect.current.options];
+      options.forEach(option => {
+        if (vals.includes(option.value)) {
+          option.selected = true;
+        } else {
+          option.selected = false;
+        }
+      });
+    }
+  };
+
+  /**
+   * @description We have to modify the children (Option component) to have a additional props that allows us to keep track of which one is selected and focused at all times and if a filter is active.
+   * The `children` prop can be either a single object (1 child) or an array of multiple children.
+   */
+  const renderOptions = () => {
+    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)
+      );
+    };
+
+    if (isSearching || filter !== "") {
+      const filteredChildren = React.Children.toArray(children).filter(
+        child =>
+          (child as ReactElement).props.children.toLowerCase().match(filter.toLowerCase()) !== null
+      );
+
+      const internalChildren = _internalRenderChildren(filterOutSelectedChildren(filteredChildren));
+
+      if (internalChildren.length === 0) {
+        return <li className={classes["no-results"]}>{noResultsLabel}</li>;
+      }
+
+      return internalChildren;
+    }
+
+    return _internalRenderChildren(filterOutSelectedChildren(React.Children.toArray(children)));
+
+    function _internalRenderChildren(internalChildren: ReactChildrenType) {
+      return React.Children.map(internalChildren, (child, index) => {
+        return React.cloneElement(child as ReactElement, {
+          onFocusChange: (childIndex: number) => {
+            setFocusedSelectItem(childIndex);
+          },
+          onOptionSelect: (optionRef: React.RefObject<HTMLLIElement>) => {
+            onOptionChangeHandler(optionRef.current);
+            setShouldClick(false);
+          },
+          isSearching: isSearching,
+          selectOpened: expanded,
+          childIndex: index,
+          hasFocus: focusedSelectItem === index,
+          shouldClick: shouldClick
+        });
+      });
+    }
+  };
+
+  const renderChevronIcon = () => {
+    return expanded ? (
+      <Icon className={classes["chevron-icon"]} icon={Icons.ChevronUp} />
+    ) : (
+      <Icon className={classes["chevron-icon"]} icon={Icons.ChevronDown} />
+    );
+  };
+
+  const icon = useDetermineStatusIcon({ success, error });
+
+  const nativeOnChangeHandler = (event: React.ChangeEvent<HTMLSelectElement>) => {
+    onChange?.(event);
+  };
+
+  useEffect(() => {
+    if (expanded) {
+      setFocusedSelectItem(0);
+      setShouldFocusButtonAfterClose(true);
+    }
+
+    if (!expanded && customSelectButtonRef.current && shouldFocusButtonAfterClose) {
+      customSelectButtonRef.current.focus();
+      setShouldFocusButtonAfterClose(false);
+    }
+  }, [expanded, customSelectButtonRef.current, shouldFocusButtonAfterClose]);
+
+  useEffect(() => {
+    syncDisplayValue(value);
+    syncSelectedOption(value);
+  }, [value]);
+
+  useBodyClick(
+    (event: MouseEvent) => !(event.target as Element).closest(".custom-select") && expanded,
+    () => {
+      setExpanded(false);
+      setListPosition({ top: 0, bottom: "initial" });
+      setOpacity(0);
+    },
+    expanded
+  );
+
+  const additionalClasses = [];
+  expanded && additionalClasses.push(classes.expanded);
+  error && additionalClasses.push(classes.error);
+  disabled && additionalClasses.push(classes.disabled);
+  className && additionalClasses.push(className);
+  success && additionalClasses.push(classes.success);
+
+  const onSelectButtonClick = () => {
+    setExpanded(!expanded);
+  };
+
+  /** 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. */
+  return (
+    <Fragment>
+      <select
+        {...filterProps(rest, /^data-/, false)}
+        tabIndex={-1}
+        multiple={true}
+        aria-hidden="true"
+        ref={nativeSelect}
+        name={name}
+        onChange={nativeOnChangeHandler}
+        className={readyclasses["sr-only"]}
+      >
+        <option value=""></option>
+        {React.Children.map(children, child => (
+          <option value={child.props.value}></option>
+        ))}
+      </select>
+      <div
+        {...filterProps(rest, /^data-/)}
+        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" }}
+        >
+          <div className={classes["display-container"]} data-display>
+            <SelectButton
+              {...selectButtonProps}
+              onClick={onSelectButtonClick}
+              name={name}
+              ref={customSelectButtonRef}
+              disabled={disabled}
+              aria-disabled={disabled}
+              aria-invalid={error}
+              aria-expanded={expanded}
+              aria-haspopup="listbox"
+              aria-labelledby={labeledBy}
+              aria-describedby={describedBy}
+            />
+            {value?.length === 0 && placeholder && (
+              <span className={classes["placeholder"]}>{placeholder}</span>
+            )}
+            {value?.length > 0 && (
+              <SelectedOptions
+                disabled={disabled}
+                display={display}
+                onClick={onSelectButtonClick}
+                onRemove={onSelectedOptionRemoveHandler}
+              />
+            )}
+          </div>
+          <div className={classes["status"]}>{icon || renderChevronIcon()}</div>
+        </div>
+
+        <div
+          ref={optionListReference}
+          className={`list-wrapper ${classes["list-wrapper"]}`}
+          style={{
+            display: expanded ? "block" : "none",
+            opacity: opacity,
+            maxHeight: optionsListMaxHeight.wrapper,
+            pointerEvents: expanded ? "auto" : "none",
+            ...listPosition
+          }}
+        >
+          <ul
+            className={addNewBtnOptionsContainerClassName}
+            role="listbox"
+            style={{ maxHeight: optionsListMaxHeight.list }}
+          >
+            {renderOptions()}
+          </ul>
+          {renderAddNew()}
+        </div>
+      </div>
+    </Fragment>
+  );
+};
+
+export const MultiSelect = React.forwardRef(MultiSelectComponent);

package/src/{.scope.ts → components/Form/Select/MultiSelect/SelectButton.module.scss}

@@ -1,4 +1,4 @@
-/*
+/*!
  * Copyright 2022 OneWelcome B.V.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,4 +14,14 @@
  *    limitations under the License.
  */
 
-export default "*";
+.add-btn {
+  position: absolute;
+  top: 0;
+  left: 0;
+  height: 100%;
+  width: 100%;
+  border: 0;
+  padding: 0;
+  background: none;
+  cursor: pointer;
+}