@navikt/ds-react 4.6.0 → 4.7.0

package/src/form/combobox/Combobox.tsx

@@ -0,0 +1,136 @@
+import cl from "clsx";
+import React, { forwardRef, useMemo, useRef } from "react";
+import { BodyShort, Label, mergeRefs } from "../..";
+import ClearButton from "./ClearButton";
+import FilteredOptions from "./FilteredOptions/FilteredOptions";
+import { useFilteredOptionsContext } from "./FilteredOptions/filteredOptionsContext";
+import SelectedOptions from "./SelectedOptions/SelectedOptions";
+import ToggleListButton from "./ToggleListButton";
+import { ComboboxProps } from "./types";
+import { useSelectedOptionsContext } from "./SelectedOptions/selectedOptionsContext";
+import ComboboxWrapper from "./ComboboxWrapper";
+import { useInputContext } from "./Input/inputContext";
+import Input from "./Input/Input";
+
+export const Combobox = forwardRef<
+  HTMLInputElement,
+  Omit<ComboboxProps, "onChange" | "options" | "size">
+>((props, ref) => {
+  const {
+    value: externalValue,
+    onClear,
+    className,
+    hideLabel = false,
+    description,
+    label,
+    clearButton = true,
+    clearButtonLabel,
+    toggleListButton = true,
+    toggleListButtonLabel,
+    inputClassName,
+    shouldShowSelectedOptions = true,
+    ...rest
+  } = props;
+
+  const toggleListButtonRef = useRef<HTMLButtonElement>(null);
+
+  const { currentOption, toggleIsListOpen } = useFilteredOptionsContext();
+  const { selectedOptions } = useSelectedOptionsContext();
+
+  const {
+    clearInput,
+    focusInput,
+    hasError,
+    inputDescriptionId,
+    inputProps,
+    inputRef,
+    value,
+    size = "medium",
+  } = useInputContext();
+
+  const mergedInputRef = useMemo(
+    () => mergeRefs([inputRef, ref]),
+    [inputRef, ref]
+  );
+
+  return (
+    <ComboboxWrapper
+      className={className}
+      hasError={hasError}
+      inputProps={inputProps}
+      inputSize={size}
+      toggleIsListOpen={toggleIsListOpen}
+      toggleListButtonRef={toggleListButtonRef}
+    >
+      <Label
+        htmlFor={inputProps.id}
+        size={size}
+        className={cl("navds-form-field__label", {
+          "navds-sr-only": hideLabel,
+        })}
+      >
+        {label}
+      </Label>
+      {!!description && (
+        <BodyShort
+          as="div"
+          className={cl("navds-form-field__description", {
+            "navds-sr-only": hideLabel,
+          })}
+          id={inputDescriptionId}
+          size={size}
+        >
+          {description}
+        </BodyShort>
+      )}
+      <div className="navds-combobox__wrapper">
+        <div
+          className={cl(
+            "navds-combobox__wrapper-inner navds-text-field__input",
+            {
+              "navds-combobox__wrapper-inner--virtually-unfocused":
+                currentOption !== null,
+            }
+          )}
+          onClick={focusInput}
+        >
+          {!shouldShowSelectedOptions ? (
+            <Input
+              id={inputProps.id}
+              ref={mergedInputRef}
+              inputClassName={inputClassName}
+              {...rest}
+            />
+          ) : (
+            <SelectedOptions selectedOptions={selectedOptions} size={size}>
+              <Input
+                id={inputProps.id}
+                ref={mergedInputRef}
+                inputClassName={inputClassName}
+                {...rest}
+              />
+            </SelectedOptions>
+          )}
+          <div>
+            {value && clearButton && (
+              <ClearButton
+                handleClear={clearInput}
+                clearButtonLabel={clearButtonLabel}
+                tabIndex={-1}
+              />
+            )}
+            {toggleListButton && (
+              <ToggleListButton
+                toggleListButtonLabel={toggleListButtonLabel}
+                ref={toggleListButtonRef}
+              />
+            )}
+          </div>
+        </div>
+        <FilteredOptions />
+      </div>
+    </ComboboxWrapper>
+  );
+});
+
+export default Combobox;

package/src/form/combobox/ComboboxProvider.tsx

@@ -0,0 +1,99 @@
+import React, { forwardRef } from "react";
+import Combobox from "./Combobox";
+import { FilteredOptionsProvider } from "./FilteredOptions/filteredOptionsContext";
+import { CustomOptionsProvider } from "./customOptionsContext";
+import { SelectedOptionsProvider } from "./SelectedOptions/selectedOptionsContext";
+import { InputContextProvider } from "./Input/inputContext";
+import { ComboboxProps } from "./types";
+
+/**
+ * A component that allows the user to search in a list of options
+ *
+ * Has options for allowing only one or multiple options to be selected,
+ * or adding new, user-submitted values.
+ *
+ * @see [📝 Documentation](https://aksel.nav.no/komponenter/core/combobox)
+ *
+ * @example
+ * ```jsx
+ * const options = ["apple", "banana", "orange"];
+ *
+ * return (
+ *    <Combobox
+ *      label="Velg en verdi"
+ *      options={options}
+ *      id="my-combobox"
+ *      shouldAutoComplete
+ *    />
+ * )
+ * ```
+ */
+const ComboboxProvider = forwardRef<HTMLInputElement, ComboboxProps>(
+  (props, ref) => {
+    const {
+      allowNewValues = false,
+      children,
+      defaultValue,
+      error,
+      errorId,
+      filteredOptions,
+      id,
+      isListOpen,
+      isLoading = false,
+      isMultiSelect,
+      onToggleSelected,
+      selectedOptions,
+      options,
+      value,
+      onChange,
+      onClear,
+      shouldAutocomplete,
+      size,
+      ...rest
+    } = props;
+    return (
+      <InputContextProvider
+        value={{
+          defaultValue,
+          error,
+          errorId,
+          id,
+          value,
+          onChange,
+          onClear,
+          shouldAutocomplete,
+          size,
+        }}
+      >
+        <CustomOptionsProvider>
+          <SelectedOptionsProvider
+            value={{
+              allowNewValues,
+              isMultiSelect,
+              selectedOptions,
+              onToggleSelected,
+              options,
+            }}
+          >
+            <FilteredOptionsProvider
+              value={{
+                allowNewValues,
+                filteredOptions,
+                isListOpen,
+                isLoading,
+                isMultiSelect,
+                options,
+              }}
+            >
+              <Combobox ref={ref} {...rest}>
+                {children}
+              </Combobox>
+            </FilteredOptionsProvider>
+          </SelectedOptionsProvider>
+        </CustomOptionsProvider>
+      </InputContextProvider>
+    );
+  }
+);
+
+export default ComboboxProvider;

package/src/form/combobox/ComboboxWrapper.tsx

@@ -0,0 +1,63 @@
+import cl from "clsx";
+import React, { useRef } from "react";
+
+type ComboboxWrapperProps = {
+  children: any;
+  className?: string;
+  hasError: boolean;
+  inputProps: {
+    disabled?: boolean;
+  };
+  inputSize: string;
+  toggleIsListOpen: (isListOpen: boolean) => void;
+  toggleListButtonRef: React.RefObject<HTMLButtonElement>;
+};
+
+const ComboboxWrapper = ({
+  children,
+  className,
+  hasError,
+  inputProps,
+  inputSize,
+  toggleIsListOpen,
+  toggleListButtonRef,
+}: ComboboxWrapperProps) => {
+  const wrapperRef = useRef<HTMLDivElement | null>(null);
+
+  function onFocusInsideWrapper(e) {
+    if (
+      !wrapperRef.current?.contains(e.relatedTarget) &&
+      toggleListButtonRef?.current !== e.target
+    ) {
+      toggleIsListOpen(true);
+    }
+  }
+
+  function onBlurWrapper(e) {
+    if (!wrapperRef.current?.contains(e.relatedTarget)) {
+      toggleIsListOpen(false);
+    }
+  }
+
+  return (
+    <div
+      ref={wrapperRef}
+      className={cl(
+        className,
+        "navds-form-field",
+        `navds-form-field--${inputSize}`,
+        "navds-search",
+        {
+          "navds-search--error": hasError,
+          "navds-search--disabled": !!inputProps.disabled,
+        }
+      )}
+      onFocus={onFocusInsideWrapper}
+      onBlur={onBlurWrapper}
+    >
+      {children}
+    </div>
+  );
+};
+
+export default ComboboxWrapper;

package/src/form/combobox/FilteredOptions/CheckIcon.tsx

@@ -0,0 +1,23 @@
+import React from "react";
+
+const CheckIcon = () => {
+  return (
+    <svg
+      width="16"
+      height="13"
+      viewBox="0 0 16 13"
+      fill="none"
+      xmlns="http://www.w3.org/2000/svg"
+      aria-hidden="true"
+    >
+      <path
+        fillRule="evenodd"
+        clipRule="evenodd"
+        fill="#005B82"
+        d="M14.2014 0L16 1.89047L4.77943 13L0 8.39552L1.79361 6.5L4.77418 9.3019L14.2014 0Z"
+      />
+    </svg>
+  );
+};
+
+export default CheckIcon;

package/src/form/combobox/FilteredOptions/FilteredOptions.tsx

@@ -0,0 +1,106 @@
+import React from "react";
+import cl from "clsx";
+import { BodyShort, Label, Loader } from "../../..";
+import { CheckmarkIcon, PlusIcon } from "@navikt/aksel-icons";
+import { useFilteredOptionsContext } from "./filteredOptionsContext";
+import { useSelectedOptionsContext } from "../SelectedOptions/selectedOptionsContext";
+import { useInputContext } from "../Input/inputContext";
+
+const FilteredOptions = () => {
+  const {
+    inputProps: { id },
+    size,
+    value,
+  } = useInputContext();
+  const {
+    allowNewValues,
+    isLoading,
+    isListOpen,
+    filteredOptions,
+    filteredOptionsIndex,
+    filteredOptionsRef,
+    isValueNew,
+    toggleIsListOpen,
+  } = useFilteredOptionsContext();
+  const { isMultiSelect, selectedOptions, toggleOption } =
+    useSelectedOptionsContext();
+
+  return (
+    <ul
+      ref={filteredOptionsRef}
+      className={cl("navds-combobox__list", {
+        "navds-combobox__list--closed": !isListOpen,
+      })}
+      id={`${id}-filtered-options`}
+      role="listbox"
+      tabIndex={-1}
+    >
+      {isLoading && (
+        <li
+          className="navds-combobox__list-item--loading"
+          role="option"
+          aria-selected={false}
+          id={`${id}-is-loading`}
+        >
+          <Loader aria-label="Søker..." />
+        </li>
+      )}
+      {isValueNew && allowNewValues && (
+        <li
+          tabIndex={-1}
+          onPointerUp={(event) => toggleOption(value, event)}
+          id={`${id}-combobox-new-option`}
+          className={cl("navds-combobox__list-item__new-option", {
+            "navds-combobox__list-item__new-option--focus":
+              filteredOptionsIndex === -1,
+          })}
+          role="option"
+          aria-selected={false}
+        >
+          <PlusIcon aria-hidden />
+          <BodyShort size={size}>
+            Legg til{" "}
+            <Label as="span" size={size}>
+              &#8220;{value}&#8221;
+            </Label>
+          </BodyShort>
+        </li>
+      )}
+      {!isLoading && filteredOptions.length === 0 && (
+        <li
+          className="navds-combobox__list-item__no-options"
+          role="option"
+          aria-selected={false}
+          id={`${id}-no-hits`}
+        >
+          Ingen søketreff
+        </li>
+      )}
+      {filteredOptions.map((option, index) => (
+        <li
+          className={cl("navds-combobox__list-item", {
+            "navds-combobox__list-item--focus": index === filteredOptionsIndex,
+            "navds-combobox__list-item--selected":
+              selectedOptions.includes(option),
+          })}
+          id={`${id}-option-${option.replace(" ", "-")}`}
+          key={option}
+          tabIndex={-1}
+          onPointerUp={(event) => {
+            toggleOption(option, event);
+            if (!isMultiSelect) {
+              toggleIsListOpen(false);
+            }
+          }}
+          role="option"
+          aria-selected={selectedOptions.includes(option)}
+        >
+          <BodyShort size={size}>{option}</BodyShort>
+          {selectedOptions.includes(option) && <CheckmarkIcon />}
+        </li>
+      ))}
+    </ul>
+  );
+};
+
+export default FilteredOptions;

package/src/form/combobox/FilteredOptions/filteredOptionsContext.tsx

@@ -0,0 +1,266 @@
+import React, {
+  useState,
+  useEffect,
+  useMemo,
+  createContext,
+  useContext,
+  useCallback,
+  useRef,
+  useLayoutEffect,
+} from "react";
+import { useCustomOptionsContext } from "../customOptionsContext";
+import { useInputContext } from "../Input/inputContext";
+import usePrevious from "../../../util/usePrevious";
+
+const normalizeText = (text: string): string =>
+  typeof text === "string" ? `${text}`.toLowerCase().trim() : "";
+
+const isPartOfText = (value, text) =>
+  normalizeText(text).startsWith(normalizeText(value ?? ""));
+
+const isValueInList = (value, list) =>
+  list?.find((listItem) => normalizeText(value) === normalizeText(listItem));
+
+const getMatchingValuesFromList = (value, list) =>
+  list?.filter((listItem) => isPartOfText(value, listItem));
+
+type FilteredOptionsContextType = {
+  activeDecendantId?: string;
+  allowNewValues?: boolean;
+  ariaDescribedBy?: string;
+  filteredOptionsRef: React.RefObject<HTMLUListElement>;
+  filteredOptionsIndex: number | null;
+  setFilteredOptionsIndex: (index: number) => void;
+  isListOpen: boolean;
+  isLoading?: boolean;
+  filteredOptions: string[];
+  isValueNew: boolean;
+  toggleIsListOpen: (newState?: boolean) => void;
+  currentOption: string | null;
+  resetFilteredOptionsIndex: () => void;
+  moveFocusUp: () => void;
+  moveFocusDown: () => void;
+  moveFocusToInput: () => void;
+  moveFocusToEnd: () => void;
+  shouldAutocomplete?: boolean;
+};
+const FilteredOptionsContext = createContext<FilteredOptionsContextType>(
+  {} as FilteredOptionsContextType
+);
+
+export const FilteredOptionsProvider = ({ children, value: props }) => {
+  const {
+    allowNewValues,
+    filteredOptions: externalFilteredOptions,
+    isListOpen: isExternalListOpen,
+    isLoading,
+    options,
+  } = props;
+  const filteredOptionsRef = useRef<HTMLUListElement | null>(null);
+  const {
+    inputProps: { id },
+    value,
+    searchTerm,
+    setValue,
+    setSearchTerm,
+    shouldAutocomplete,
+  } = useInputContext();
+
+  const [filteredOptionsIndex, setFilteredOptionsIndex] = useState<
+    number | null
+  >(null);
+  const [isInternalListOpen, setInternalListOpen] = useState(false);
+  const { customOptions } = useCustomOptionsContext();
+
+  const filteredOptions = useMemo(() => {
+    if (externalFilteredOptions) {
+      return externalFilteredOptions;
+    }
+    const opts = [...customOptions, ...options];
+    setFilteredOptionsIndex(null);
+    return getMatchingValuesFromList(searchTerm, opts);
+  }, [customOptions, externalFilteredOptions, options, searchTerm]);
+
+  const previousSearchTerm = usePrevious(searchTerm);
+
+  useLayoutEffect(() => {
+    if (
+      shouldAutocomplete &&
+      normalizeText(searchTerm) !== "" &&
+      (previousSearchTerm?.length || 0) < searchTerm.length &&
+      filteredOptions.length > 0 &&
+      !isValueInList(searchTerm, filteredOptions)
+    ) {
+      setValue(
+        `${searchTerm}${filteredOptions[0].substring(searchTerm.length)}`
+      );
+      setSearchTerm(searchTerm);
+    }
+  }, [
+    filteredOptions,
+    previousSearchTerm,
+    searchTerm,
+    setSearchTerm,
+    setValue,
+    shouldAutocomplete,
+  ]);
+
+  const isListOpen = useMemo(() => {
+    return isExternalListOpen ?? isInternalListOpen;
+  }, [isExternalListOpen, isInternalListOpen]);
+
+  const toggleIsListOpen = useCallback((newState?: boolean) => {
+    setFilteredOptionsIndex(null);
+    setInternalListOpen((oldState) => newState ?? !oldState);
+  }, []);
+
+  const isValueNew = useMemo(
+    () => Boolean(value) && !isValueInList(value, filteredOptions),
+    [value, filteredOptions]
+  );
+
+  const getMinimumIndex = useCallback(() => {
+    return isValueNew && allowNewValues ? -1 : 0;
+  }, [allowNewValues, isValueNew]);
+
+  const ariaDescribedBy = useMemo(() => {
+    if (!isLoading && filteredOptions.length === 0) {
+      return `${id}-no-hits`;
+    } else if ((value && value !== "") || isLoading) {
+      if (shouldAutocomplete && filteredOptions[0]) {
+        return `${id}-option-${filteredOptions[0].replace(" ", "-")}`;
+      } else if (isLoading) {
+        return `${id}-is-loading`;
+      }
+    } else {
+      return undefined;
+    }
+  }, [isLoading, value, shouldAutocomplete, filteredOptions, id]);
+
+  const currentOption = useMemo(() => {
+    if (filteredOptionsIndex == null) {
+      return null;
+    }
+    if (filteredOptionsIndex === -1) {
+      return value;
+    }
+    return filteredOptions[filteredOptionsIndex];
+  }, [filteredOptionsIndex, filteredOptions, value]);
+
+  const resetFilteredOptionsIndex = () => {
+    setFilteredOptionsIndex(getMinimumIndex());
+  };
+
+  const scrollToOption = useCallback((newIndex: number) => {
+    if (
+      filteredOptionsRef.current &&
+      filteredOptionsRef.current.children[newIndex]
+    ) {
+      const child = filteredOptionsRef.current.children[newIndex];
+      const { top, bottom } = child.getBoundingClientRect();
+      const parentRect = filteredOptionsRef.current.getBoundingClientRect();
+      if (top < parentRect.top || bottom > parentRect.bottom) {
+        child.scrollIntoView({ block: "nearest" });
+      }
+    }
+  }, []);
+
+  useEffect(() => {
+    if (filteredOptionsIndex !== null && isListOpen) {
+      scrollToOption(filteredOptionsIndex);
+    }
+  }, [filteredOptionsIndex, isListOpen, scrollToOption]);
+
+  const moveFocusToInput = useCallback(() => {
+    setFilteredOptionsIndex(null);
+    toggleIsListOpen(false);
+  }, [toggleIsListOpen]);
+
+  const moveFocusToEnd = useCallback(() => {
+    const lastIndex = filteredOptions.length - 1;
+    toggleIsListOpen(true);
+    setFilteredOptionsIndex(lastIndex);
+  }, [filteredOptions.length, toggleIsListOpen]);
+
+  const moveFocusUp = useCallback(() => {
+    if (filteredOptionsIndex === null) {
+      return;
+    }
+    if (filteredOptionsIndex === getMinimumIndex()) {
+      toggleIsListOpen(false);
+      setFilteredOptionsIndex(null);
+    } else {
+      const newIndex = Math.max(getMinimumIndex(), filteredOptionsIndex - 1);
+      setFilteredOptionsIndex(newIndex);
+    }
+  }, [filteredOptionsIndex, getMinimumIndex, toggleIsListOpen]);
+
+  const moveFocusDown = useCallback(() => {
+    if (filteredOptionsIndex === null || !isListOpen) {
+      toggleIsListOpen(true);
+      if (allowNewValues || filteredOptions.length >= 1) {
+        setFilteredOptionsIndex(getMinimumIndex());
+      }
+      return;
+    }
+    const newIndex = Math.min(
+      filteredOptionsIndex + 1,
+      Math.max(getMinimumIndex(), filteredOptions.length - 1)
+    );
+    setFilteredOptionsIndex(newIndex);
+  }, [
+    allowNewValues,
+    filteredOptions.length,
+    filteredOptionsIndex,
+    getMinimumIndex,
+    isListOpen,
+    toggleIsListOpen,
+  ]);
+
+  const activeDecendantId = useMemo(() => {
+    if (filteredOptionsIndex === null) {
+      return undefined;
+    } else if (filteredOptionsIndex === -1) {
+      return `${id}-combobox-new-option`;
+    } else {
+      return `${id}-option-${currentOption?.replace(" ", "-")}`;
+    }
+  }, [filteredOptionsIndex, currentOption, id]);
+
+  const filteredOptionsState = {
+    activeDecendantId,
+    allowNewValues,
+    filteredOptionsRef,
+    filteredOptionsIndex,
+    setFilteredOptionsIndex,
+    shouldAutocomplete,
+    isListOpen,
+    isLoading,
+    filteredOptions,
+    isValueNew,
+    toggleIsListOpen,
+    currentOption,
+    resetFilteredOptionsIndex,
+    moveFocusUp,
+    moveFocusDown,
+    moveFocusToInput,
+    moveFocusToEnd,
+    ariaDescribedBy,
+  };
+
+  return (
+    <FilteredOptionsContext.Provider value={filteredOptionsState}>
+      {children}
+    </FilteredOptionsContext.Provider>
+  );
+};
+
+export const useFilteredOptionsContext = () => {
+  const context = useContext(FilteredOptionsContext);
+  if (!context) {
+    throw new Error(
+      "useFilteredOptionsContext must be used within a FilteredOptionsProvider"
+    );
+  }
+  return context;
+};