@onewelcome/react-lib-components 8.5.0 → 8.7.0

package/src/components/Form/Input/Input.tsx

@@ -28,6 +28,7 @@ import readyclasses from "../../../readyclasses.module.scss";
 import { FormElement } from "../form.interfaces";
 import { useDetermineStatusIcon } from "../../../hooks/useDetermineStatusIcon";
 import { MergeElementProps } from "../../../interfaces";
+import { withReadOnly } from "../../withReadOnly";
 
 export const dateTypes = ["date", "time", "datetime-local"] as const;
 
@@ -51,6 +52,7 @@ export type Props = MergeElementProps<
     type: Type;
     suffix?: ReactNode;
     prefix?: ReactNode;
+    readOnlyView?: boolean;
   }
 >;
 
@@ -69,6 +71,7 @@ const InputComponent: ForwardRefRenderFunction<HTMLInputElement, Props> = (
     disabled,
     onFocus,
     onBlur,
+    readOnlyView,
     ...rest
   }: Props,
   ref: Ref<HTMLInputElement>
@@ -106,13 +109,16 @@ const InputComponent: ForwardRefRenderFunction<HTMLInputElement, Props> = (
   success && wrapperClasses.push(classes["success"]);
 
   const icon = useDetermineStatusIcon({ success, error });
+  const readOnlyMode = rest["data-readonlyview"] as boolean;
 
   return (
     <div
       ref={inputWrapperRef}
       {...wrapperProps}
       style={{ ...style }}
+      data-readonlyview={readOnlyMode}
       className={`${classes["input-wrapper"]} ${wrapperClasses.join(" ")}`}
+      tabIndex={readOnlyMode ? 0 : -1}
     >
       {prefix && (
         <div data-prefix className={classes["prefix"]}>
@@ -122,6 +128,8 @@ const InputComponent: ForwardRefRenderFunction<HTMLInputElement, Props> = (
       <input
         {...rest}
         ref={ref}
+        aria-readonly={readOnlyMode}
+        readOnly={readOnlyMode}
         onFocus={event => {
           setFocus(true);
           onFocus?.(event);
@@ -136,6 +144,7 @@ const InputComponent: ForwardRefRenderFunction<HTMLInputElement, Props> = (
         disabled={disabled}
         className={inputClassNames.join(" ")}
         spellCheck={rest.spellCheck ?? false}
+        tabIndex={readOnlyMode ? -1 : 0}
       />
       {icon}
       {suffix && (
@@ -149,4 +158,4 @@ const InputComponent: ForwardRefRenderFunction<HTMLInputElement, Props> = (
   );
 };
 
-export const Input = React.forwardRef(InputComponent);
+export const Input = withReadOnly(React.forwardRef(InputComponent));

package/src/components/Form/Radio/Radio.module.scss

@@ -143,3 +143,49 @@
   color: var(--disabled);
   pointer-events: none;
 }
+
+[data-readonlyview="true"] {
+  & .radio-wrapper {
+    color: var(--read-only-text-color);
+
+    & span.input {
+      color: var(--read-only-text-color);
+      cursor: not-allowed;
+
+      &:before {
+        outline: 1px solid var(--read-only-border-color);
+        outline-offset: -1px;
+        border-radius: 50%;
+      }
+    }
+  }
+
+  label {
+    user-select: text;
+  }
+}
+
+input[type="radio"] {
+  &[data-readonlyview="true"] {
+    & ~ span.input {
+      color: var(--read-only-text-color);
+      cursor: not-allowed;
+
+      &:before {
+        outline: 1px solid var(--read-only-border-color);
+        outline-offset: -1px;
+        border-radius: 50%;
+      }
+    }
+
+    & ~ label {
+      user-select: text;
+      pointer-events: none;
+    }
+
+    & :focus-visible {
+      outline: 2px solid var(--color-focus);
+      outline-offset: 2px;
+    }
+  }
+}

package/src/components/Form/Radio/Radio.tsx

@@ -24,6 +24,7 @@ import {
   FormSelectorWrapper,
   Props as FormSelectorWrapperProps
 } from "../FormSelectorWrapper/FormSelectorWrapper";
+import { withReadOnly } from "../../withReadOnly";
 
 export interface Props extends ComponentPropsWithRef<"input">, Omit<FormSelector, "success"> {
   children: string;
@@ -127,4 +128,4 @@ const RadioComponent: ForwardRefRenderFunction<HTMLInputElement, Props> = (
   );
 };
 
-export const Radio = React.forwardRef(RadioComponent);
+export const Radio = withReadOnly(React.forwardRef(RadioComponent));

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

@@ -96,6 +96,10 @@ $listItemHeight: 2.5rem;
     }
   }
 
+  .list-wrapper-container {
+    position: relative;
+  }
+
   .list-wrapper {
     border-color: var(--light-grey-border);
     border-style: var(--input-border-style);
@@ -106,7 +110,6 @@ $listItemHeight: 2.5rem;
     box-shadow: 0px 8px 10px 0px #01053224;
     position: absolute;
     z-index: variables.$select-z-index;
-    top: 44px;
     left: 0;
     width: 100%;
     overflow: auto;
@@ -255,3 +258,34 @@ $listItemHeight: 2.5rem;
     }
   }
 }
+
+[data-readonlyview="true"] {
+  & .custom-select {
+    color: var(--read-only-text-color);
+    border-color: var(--read-only-border-color);
+    background-color: var(--color-white);
+
+    &.error,
+    &.success {
+      border-color: var(--read-only-border-color);
+    }
+
+    button {
+      pointer-events: none;
+    }
+  }
+
+  & .status {
+    .chevron-icon {
+      visibility: hidden;
+    }
+  }
+
+  &:hover:not(.disabled):not(.expanded):not(.error) {
+    .custom-select:not(:focus) {
+      color: var(--read-only-text-color);
+      border-color: var(--read-only-border-color);
+      background-color: var(--color-white);
+    }
+  }
+}

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

@@ -18,25 +18,25 @@ import classes from "./MultiSelect.module.scss";
 
 import React, {
   ForwardRefRenderFunction,
-  Fragment,
   ReactElement,
   createRef,
   useEffect,
   useRef,
   useState
 } from "react";
-import { useBodyClick } from "../../../../hooks/useBodyClick";
+import { useClickOutside } from "../../../../hooks/useClickOutside";
 import { useDetermineStatusIcon } from "../../../../hooks/useDetermineStatusIcon";
 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 { MultiSelectProps, Position } from "../Select.interfaces";
 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";
+import { withReadOnly } from "../../../withReadOnly";
 
 const getOptionId = (multiSelectId: string, optionIndex: number) =>
   `${multiSelectId}_option${optionIndex}`;
@@ -62,6 +62,7 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
     onChange,
     addNew,
     search = { enabled: true, renderThreshold: 0, searchPlaceholder: "Search item" },
+    isReadOnlyView,
     ...rest
   }: MultiSelectProps,
   ref
@@ -135,6 +136,7 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
   };
 
   const customSelectButtonRef = useRef<HTMLButtonElement>(null);
+  const readOnlyView = !!rest["data-readonlyview"] || isReadOnlyView;
   const { onArrowNavigation } = useArrowNavigation({
     expanded,
     setExpanded,
@@ -144,7 +146,8 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
     addBtnRef,
     searchInputRef,
     customSelectButtonRef,
-    onClose: resetSearchState
+    onClose: resetSearchState,
+    isReadOnlyView: readOnlyView
   });
 
   const { listPosition, opacity, optionsListMaxHeight, setListPosition, setOpacity } =
@@ -270,15 +273,16 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
     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 myElementRef = useRef<HTMLDivElement>(null);
+
+  useClickOutside(myElementRef, () => {
+    if (!expanded) {
+      return;
+    }
+    setExpanded(false);
+    setListPosition(Position.Below);
+    setOpacity(0);
+  }, [expanded]);
 
   const additionalClasses = [];
   expanded && additionalClasses.push(classes.expanded);
@@ -288,13 +292,44 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
   success && additionalClasses.push(classes.success);
 
   const onSelectButtonClick = () => {
+    if (rest["data-readonlyview"] || isReadOnlyView) {
+      return;
+    }
     setExpanded(expanded => !expanded);
     setShouldClick(false);
   };
 
+  const optionsElement = (
+    <div className={`list-wrapper-container ${classes["list-wrapper-container"]}`}>
+      <div
+        ref={optionListReference}
+        className={`list-wrapper ${classes["list-wrapper"]}`}
+        style={{
+          display: expanded ? "block" : "none",
+          opacity: opacity,
+          maxHeight: optionsListMaxHeight.wrapper,
+          pointerEvents: expanded ? "auto" : "none",
+          top: listPosition === Position.Below ? "4px" : "initial",
+          bottom: listPosition === Position.Above ? "4px" : "initial"
+        }}
+      >
+        <ul
+          id={getListboxId(multiSelectId.current)}
+          className={addNewBtnOptionsContainerClassName}
+          role="listbox"
+          aria-multiselectable="true"
+          style={{ maxHeight: optionsListMaxHeight.list }}
+        >
+          {renderOptions()}
+        </ul>
+        {renderAddNew()}
+      </div>
+    </div>
+  );
+
   /** 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>
+    <div ref={myElementRef}>
       <select
         {...filterProps(rest, /^data-/, false)}
         tabIndex={-1}
@@ -317,6 +352,7 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
         onKeyDown={onArrowNavigation}
         className={`custom-select ${classes.select} ${additionalClasses.join(" ")}`}
       >
+        {listPosition === Position.Above ? optionsElement : undefined}
         <div
           className={`${classes["custom-select"]} ${additionalClasses.join(" ")} `}
           style={{ display: "flex" }}
@@ -350,31 +386,10 @@ const MultiSelectComponent: ForwardRefRenderFunction<HTMLSelectElement, MultiSel
           </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
-            id={getListboxId(multiSelectId.current)}
-            className={addNewBtnOptionsContainerClassName}
-            role="listbox"
-            aria-multiselectable="true"
-            style={{ maxHeight: optionsListMaxHeight.list }}
-          >
-            {renderOptions()}
-          </ul>
-          {renderAddNew()}
-        </div>
+        {listPosition === Position.Below ? optionsElement : undefined}
       </div>
-    </Fragment>
+    </div>
   );
 };
 
-export const MultiSelect = React.forwardRef(MultiSelectComponent);
+export const MultiSelect = withReadOnly(React.forwardRef(MultiSelectComponent));

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

@@ -29,3 +29,11 @@
     cursor: pointer;
   }
 }
+
+[data-readonlyview="true"] {
+  .tag {
+    .remove-btn {
+      display: none;
+    }
+  }
+}

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

@@ -24,6 +24,7 @@ interface UseArrowNavigationParams {
   searchInputRef: React.RefObject<HTMLInputElement>;
   customSelectButtonRef: React.RefObject<HTMLButtonElement>;
   onClose: () => void;
+  isReadOnlyView?: boolean;
 }
 
 /** @scope .*/
@@ -36,9 +37,13 @@ export const useArrowNavigation = ({
   addBtnRef,
   searchInputRef,
   customSelectButtonRef,
-  onClose
+  onClose,
+  isReadOnlyView = false
 }: UseArrowNavigationParams) => {
   const onArrowNavigation = (event: React.KeyboardEvent) => {
+    if (isReadOnlyView) {
+      return;
+    }
     const codesToPreventDefault = ["ArrowDown", "ArrowUp", "Escape", "End", "Home"];
     const hasAddBtn = !!addBtnRef?.current;
     const childrenCountWithAddButton = childrenCount + (hasAddBtn ? 1 : 0);

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

@@ -0,0 +1,98 @@
+/*
+ * 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";
+import { MultiOption } from "./MultiOption";
+
+export interface UseMultiSelectArgs {
+  initialOptions?: string[];
+  allOptions?: string[];
+  setAllOptions?: (options: string[]) => void;
+  pickedOptions: string[];
+  setPickedOptions: (options: string[]) => void;
+  onAddNew?: (newOption: string) => void;
+}
+
+export interface UseMultiSelectResult {
+  handleOptionChange: (e: React.ChangeEvent<HTMLSelectElement>) => void;
+  onAddNew: (newValue: string) => void;
+  optionElements: React.JSX.Element[];
+}
+
+export type UseMultiSelect = (args: UseMultiSelectArgs) => UseMultiSelectResult;
+
+export const useMultiSelect: UseMultiSelect = ({
+  initialOptions,
+  pickedOptions,
+  allOptions = pickedOptions,
+  setPickedOptions,
+  setAllOptions = setPickedOptions,
+  onAddNew
+}) => {
+  const handleOptionChange = (e: React.ChangeEvent<HTMLSelectElement>) => {
+    const htmlOptions = e.target.options;
+
+    const newPickedOptions = [...pickedOptions];
+    Array.from(htmlOptions).forEach(option => {
+      const selected = option.selected;
+      const exists = pickedOptions.includes(option.value);
+
+      const shouldAdd = !exists && selected;
+      const shouldRemove = exists && !selected;
+
+      if (shouldAdd) {
+        newPickedOptions.push(option.value);
+      } else if (shouldRemove) {
+        const index = newPickedOptions.indexOf(option.value);
+        newPickedOptions.splice(index, 1);
+
+        if (initialOptions && !initialOptions.includes(option.value)) {
+          setAllOptions?.(allOptions.filter(value => value !== option.value));
+        }
+      }
+    });
+    setPickedOptions(newPickedOptions);
+  };
+
+  const onAddNewWrapper = (value: string) => {
+    if (value == undefined || value.length === 0) {
+      onAddNew?.("");
+      return;
+    }
+
+    const trimmedValue = value.trim();
+    if (trimmedValue.length === 0 || allOptions.includes(trimmedValue)) {
+      return;
+    }
+
+    setAllOptions?.([...allOptions, trimmedValue]);
+    setPickedOptions([...pickedOptions, trimmedValue]);
+
+    onAddNew?.(trimmedValue);
+  };
+
+  const optionElements = allOptions.map(option => (
+    <MultiOption key={option} value={option}>
+      {option}
+    </MultiOption>
+  ));
+
+  return {
+    handleOptionChange,
+    onAddNew: onAddNewWrapper,
+    optionElements
+  };
+};

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

@@ -50,15 +50,16 @@ export interface SelectProps<V extends string | readonly string[] | undefined>
   noResultsLabel?: string;
   onChange?: (event: React.ChangeEvent<HTMLSelectElement>, child?: ReactElement) => void;
   addNew?: AddNewProps;
+  isReadOnlyView?: boolean;
 }
 
 export type SingleSelectProps = SelectProps<string>;
 export type MultiSelectProps = SelectProps<string[]>;
 
-export type Position = {
-  top: number | `${number}rem` | "initial";
-  bottom: number | `${number}rem` | "initial";
-};
+export enum Position {
+  Above = "Above",
+  Below = "Below"
+}
 
 export interface UseArrowNavigationParams {
   expanded: boolean;
@@ -72,6 +73,7 @@ export interface UseArrowNavigationParams {
   searchInputRef: React.RefObject<HTMLInputElement>;
   addBtnRef?: React.RefObject<HTMLButtonElement>;
   renderThreshold: number;
+  isReadOnlyView?: boolean;
 }
 
 export interface UseSelectPositionListParams {

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

@@ -88,6 +88,10 @@ $listItemHeight: 2.5rem;
     }
   }
 
+  .list-wrapper-container {
+    position: relative;
+  }
+
   .list-wrapper {
     border-color: var(--light-grey-border);
     border-style: var(--input-border-style);
@@ -96,7 +100,6 @@ $listItemHeight: 2.5rem;
     box-shadow: 0 8px 10px 0 #01053224;
     position: absolute;
     z-index: variables.$select-z-index;
-    top: 44px;
     left: 0;
     width: 100%;
     overflow: auto;
@@ -157,6 +160,43 @@ $listItemHeight: 2.5rem;
       }
     }
   }
+
+  &[data-readonlyview="true"] {
+    user-select: text;
+    pointer-events: none;
+
+    & button[type="button"] {
+      background-color: var(--color-white);
+      color: var(--read-only-text-color);
+      border-color: var(--read-only-border-color);
+
+      & .selected {
+        color: var(--read-only-text-color);
+      }
+
+      &.error,
+      &.success {
+        border-color: var(--read-only-border-color);
+        color: var(--read-only-text-color);
+
+        & .status {
+          visibility: visible;
+        }
+      }
+
+      & .status {
+        & .chevron-icon {
+          visibility: hidden;
+        }
+      }
+    }
+    & .list-wrapper {
+      visibility: hidden;
+      & ul {
+        display: none;
+      }
+    }
+  }
 }
 
 .selected-option {
@@ -243,3 +283,22 @@ $listItemHeight: 2.5rem;
     }
   }
 }
+
+[data-readonlyview="true"] {
+  [data-readonlyview] {
+    & button {
+      border-color: var(--read-only-border-color);
+
+      & .status {
+        & .chevron-icon {
+          visibility: hidden;
+        }
+      }
+
+      &.error {
+        border-color: var(--read-only-border-color);
+        color: var(--read-only-text-color);
+      }
+    }
+  }
+}