@navikt/ds-react 4.6.1 → 4.7.0

package/src/form/combobox/SelectedOptions/selectedOptionsContext.tsx

@@ -0,0 +1,147 @@
+import React, {
+  createContext,
+  useCallback,
+  useContext,
+  useMemo,
+  useState,
+} from "react";
+import usePrevious from "../../../util/usePrevious";
+import { useInputContext } from "../Input/inputContext";
+import { ComboboxProps } from "../types";
+import { useCustomOptionsContext } from "../customOptionsContext";
+
+type SelectedOptionsContextType = {
+  addSelectedOption: (option: string) => void;
+  isMultiSelect?: boolean;
+  removeSelectedOption: (option: string) => void;
+  prevSelectedOptions?: string[];
+  selectedOptions: string[];
+  setSelectedOptions: (any) => void;
+  toggleOption: (
+    option: string,
+    event: React.KeyboardEvent | React.PointerEvent
+  ) => void;
+};
+
+const SelectedOptionsContext = createContext<SelectedOptionsContextType>(
+  {} as SelectedOptionsContextType
+);
+
+export const SelectedOptionsProvider = ({
+  children,
+  value,
+}: {
+  children: any;
+  value: Pick<
+    ComboboxProps,
+    | "allowNewValues"
+    | "isMultiSelect"
+    | "options"
+    | "selectedOptions"
+    | "onToggleSelected"
+  >;
+}) => {
+  const { clearInput, focusInput } = useInputContext();
+  const { customOptions, removeCustomOption, addCustomOption } =
+    useCustomOptionsContext();
+  const {
+    allowNewValues,
+    isMultiSelect,
+    selectedOptions: externalSelectedOptions,
+    onToggleSelected,
+    options,
+  } = value;
+  const [internalSelectedOptions, setSelectedOptions] = useState<string[]>([]);
+  const selectedOptions = useMemo(
+    () =>
+      externalSelectedOptions ?? [...customOptions, ...internalSelectedOptions],
+    [customOptions, externalSelectedOptions, internalSelectedOptions]
+  );
+
+  const addSelectedOption = useCallback(
+    (option: string) => {
+      if (
+        !options
+          .map((opt) => opt.toLowerCase())
+          .includes(option?.toLowerCase?.())
+      ) {
+        allowNewValues && addCustomOption(option);
+      } else if (isMultiSelect) {
+        setSelectedOptions((prevSelectedOptions) => [
+          ...prevSelectedOptions,
+          option,
+        ]);
+      } else {
+        setSelectedOptions([option]);
+      }
+      onToggleSelected?.(option, true);
+    },
+    [addCustomOption, allowNewValues, isMultiSelect, onToggleSelected, options]
+  );
+
+  const removeSelectedOption = useCallback(
+    (option: string) => {
+      if (customOptions.includes(option)) {
+        removeCustomOption(option);
+      } else {
+        setSelectedOptions((prevSelectedOptions) =>
+          prevSelectedOptions.filter(
+            (selectedOption) => selectedOption !== option
+          )
+        );
+      }
+      onToggleSelected?.(option, false);
+    },
+    [customOptions, onToggleSelected, removeCustomOption]
+  );
+
+  const toggleOption = useCallback(
+    (option: string, event: React.KeyboardEvent | React.PointerEvent) => {
+      if (selectedOptions.includes(option)) {
+        removeSelectedOption(option);
+      } else {
+        addSelectedOption(option);
+      }
+      if (!isMultiSelect) {
+        clearInput(event);
+      }
+      focusInput();
+    },
+    [
+      addSelectedOption,
+      clearInput,
+      focusInput,
+      isMultiSelect,
+      removeSelectedOption,
+      selectedOptions,
+    ]
+  );
+
+  const prevSelectedOptions = usePrevious<string[]>(selectedOptions);
+
+  const selectedOptionsState = {
+    addSelectedOption,
+    isMultiSelect,
+    removeSelectedOption,
+    prevSelectedOptions,
+    selectedOptions,
+    setSelectedOptions,
+    toggleOption,
+  };
+
+  return (
+    <SelectedOptionsContext.Provider value={selectedOptionsState}>
+      {children}
+    </SelectedOptionsContext.Provider>
+  );
+};
+
+export const useSelectedOptionsContext = () => {
+  const context = useContext(SelectedOptionsContext);
+  if (!context) {
+    throw new Error(
+      "useSelectedOptionsContext must be used within a SelectedOptionsProvider"
+    );
+  }
+  return context;
+};

package/src/form/combobox/ToggleListButton.tsx

@@ -0,0 +1,37 @@
+import React, { forwardRef } from "react";
+import { ChevronUpIcon, ChevronDownIcon } from "@navikt/aksel-icons";
+
+import { useFilteredOptionsContext } from "./FilteredOptions/filteredOptionsContext";
+
+interface ToggleListButtonProps {
+  toggleListButtonLabel?: string;
+}
+
+export const ToggleListButton = forwardRef<
+  HTMLButtonElement,
+  ToggleListButtonProps
+>(({ toggleListButtonLabel }, ref) => {
+  const { isListOpen, toggleIsListOpen } = useFilteredOptionsContext();
+  return (
+    <button
+      type="button"
+      onPointerUp={() => toggleIsListOpen()}
+      onKeyDown={({ key }) => key === "Enter" && toggleIsListOpen()}
+      className="navds-combobox__button-toggle-list"
+      aria-expanded={isListOpen}
+      tabIndex={-1}
+      ref={ref}
+    >
+      <span className="navds-sr-only">
+        {toggleListButtonLabel ?? "Alternativer"}
+      </span>
+      {isListOpen ? (
+        <ChevronUpIcon aria-hidden />
+      ) : (
+        <ChevronDownIcon aria-hidden />
+      )}
+    </button>
+  );
+});
+
+export default ToggleListButton;

package/src/form/combobox/combobox.stories.tsx

@@ -0,0 +1,413 @@
+/* eslint-disable react-hooks/rules-of-hooks */
+import { Meta } from "@storybook/react";
+import React, { useState, useId, useMemo } from "react";
+import { userEvent, within } from "@storybook/testing-library";
+import { Chips, UNSAFE_Combobox, TextField } from "../../index";
+import { expect } from "@storybook/jest";
+
+export default {
+  title: "ds-react/Combobox",
+  component: UNSAFE_Combobox,
+  argTypes: {
+    isListOpen: {
+      control: {
+        type: "boolean",
+      },
+    },
+    isLoading: {
+      control: {
+        type: "boolean",
+      },
+    },
+  },
+} as Meta;
+
+const options = [
+  "banana",
+  "apple",
+  "apple pie",
+  "tangerine",
+  "pear",
+  "grape",
+  "kiwi",
+  "mango",
+  "passion fruit",
+  "pineapple",
+  "strawberry",
+  "watermelon",
+  "grape fruit",
+];
+
+const initialSelectedOptions = ["passion fruit", "grape fruit"];
+
+const DemoContainer = ({
+  dataTheme,
+  children,
+}: {
+  children: any;
+  dataTheme: "dark" | "light";
+}) => (
+  <div data-theme={dataTheme} style={{ width: "300px" }}>
+    {children}
+  </div>
+);
+
+export const Default = (props) => {
+  const id = useId();
+  return (
+    <DemoContainer dataTheme={props.darkMode}>
+      <UNSAFE_Combobox
+        options={props.options}
+        label="Hva er dine favorittfrukter?"
+        /* everything under here is optional? */
+        shouldAutocomplete={props.shouldAutoComplete}
+        size="medium"
+        id={id}
+      />
+    </DemoContainer>
+  );
+};
+
+Default.args = {
+  options,
+  shouldAutoComplete: true,
+};
+
+export function MultiSelect(props) {
+  const id = useId();
+  return (
+    <DemoContainer dataTheme={props.darkMode}>
+      <UNSAFE_Combobox
+        id={id}
+        label="Komboboks - velg flere"
+        options={props.options}
+        isMultiSelect={props.isMultiSelect}
+      />
+    </DemoContainer>
+  );
+}
+
+MultiSelect.args = {
+  options,
+  isMultiSelect: true,
+};
+
+export function MultiSelectWithAddNewOptions(props) {
+  const id = useId();
+  return (
+    <DemoContainer dataTheme={props.darkMode}>
+      <UNSAFE_Combobox
+        id={id}
+        isMultiSelect={props.isMultiSelect}
+        label="Komboboks (med mulighet for å legge til nye verdier)"
+        options={props.options}
+        allowNewValues={props.allowNewValues}
+      />
+    </DemoContainer>
+  );
+}
+
+MultiSelectWithAddNewOptions.args = {
+  allowNewValues: true,
+  isMultiSelect: true,
+  options,
+  shouldAutocomplete: false,
+};
+
+export const MultiSelectWithExternalChips = (props) => {
+  const [selectedOptions, setSelectedOptions] = useState<string[]>(
+    props.selectedOptions
+  );
+  const [value, setValue] = useState("");
+  const id = useId();
+
+  const toggleSelected = (option) =>
+    selectedOptions.includes(option)
+      ? setSelectedOptions(selectedOptions.filter((opt) => opt !== option))
+      : setSelectedOptions([...selectedOptions, option]);
+  return (
+    <DemoContainer dataTheme={props.darkMode}>
+      {selectedOptions && (
+        <Chips>
+          {selectedOptions.map((option) => (
+            <Chips.Removable
+              key={option}
+              onPointerUp={() => toggleSelected(option)}
+              onKeyUp={(e) => e.key === "Enter" && toggleSelected(option)}
+            >
+              {option}
+            </Chips.Removable>
+          ))}
+        </Chips>
+      )}
+      <UNSAFE_Combobox
+        options={options}
+        selectedOptions={selectedOptions}
+        onToggleSelected={(option: string) => toggleSelected(option)}
+        isListOpen={props.isListOpen}
+        isMultiSelect
+        value={props.controlled ? value : undefined}
+        onChange={(event) =>
+          props.controlled ? setValue(event.currentTarget.value) : undefined
+        }
+        label="Komboboks"
+        size="medium"
+        error={props.error && "error here"}
+        id={id}
+        shouldShowSelectedOptions={false}
+      />
+    </DemoContainer>
+  );
+};
+
+MultiSelectWithExternalChips.args = {
+  controlled: false,
+  options,
+  selectedOptions: [],
+};
+
+export function Loading(props) {
+  const id = useId();
+  return (
+    <DemoContainer dataTheme={props.darkMode}>
+      <UNSAFE_Combobox
+        id={id}
+        label="Komboboks (laster)"
+        options={[]}
+        selectedOptions={[]}
+        isListOpen={props.isListOpen}
+        isLoading={props.isLoading}
+      />
+    </DemoContainer>
+  );
+}
+
+Loading.args = {
+  isLoading: true,
+  isListOpen: true,
+};
+
+export function ComboboxWithNoHits(props) {
+  const id = useId();
+  const [value, setValue] = useState(props.value);
+  return (
+    <DemoContainer dataTheme={props.darkMode}>
+      <UNSAFE_Combobox
+        id={id}
+        label="Komboboks (uten søketreff)"
+        options={props.options}
+        value={value}
+        onChange={(event) => setValue(event.currentTarget.value)}
+        isListOpen={true}
+      />
+    </DemoContainer>
+  );
+}
+
+ComboboxWithNoHits.args = {
+  options,
+  value: "Orange",
+};
+
+export const Controlled = (props) => {
+  const id = useId();
+  const [value, setValue] = useState(props.value);
+  const [selectedOptions, setSelectedOptions] = useState(props.selectedOptions);
+  const filteredOptions = useMemo(
+    () => props.options.filter((option) => option.includes(value)),
+    [props.options, value]
+  );
+
+  const onToggleSelected = (option, isSelected) => {
+    if (isSelected) {
+      setSelectedOptions([...selectedOptions, option]);
+    } else {
+      setSelectedOptions(selectedOptions.filter((o) => o !== option));
+    }
+  };
+
+  return (
+    <DemoContainer dataTheme={props.darkMode}>
+      <TextField
+        label="Overstyr value"
+        onChange={(event) => setValue(event.target.value)}
+        value={value}
+      />
+      <br />
+      <UNSAFE_Combobox
+        label="Hva er dine favorittfrukter?"
+        id={id}
+        filteredOptions={filteredOptions}
+        isMultiSelect
+        options={props.options}
+        onChange={(event) => setValue(event.target.value)}
+        onToggleSelected={onToggleSelected}
+        selectedOptions={selectedOptions}
+        value={value}
+      />
+    </DemoContainer>
+  );
+};
+
+Controlled.args = {
+  value: "apple",
+  options,
+  selectedOptions: initialSelectedOptions,
+};
+
+export const ComboboxSizes = (props) => (
+  <DemoContainer dataTheme={props.darkMode}>
+    <UNSAFE_Combobox
+      label="Hva er dine favorittfrukter?"
+      description="Medium single-select"
+      options={options}
+    />
+    <br />
+    <UNSAFE_Combobox
+      label="Hva er dine favorittfrukter?"
+      description="Small single-select"
+      options={options}
+      size="small"
+    />
+    <br />
+    <UNSAFE_Combobox
+      label="Hva er dine favorittfrukter?"
+      description="Medium multiselect"
+      options={options}
+      isMultiSelect
+      allowNewValues
+    />
+    <br />
+    <UNSAFE_Combobox
+      label="Hva er dine favorittfrukter?"
+      description="Small multiselect"
+      options={options}
+      isMultiSelect
+      size="small"
+      allowNewValues
+    />
+  </DemoContainer>
+);
+
+ComboboxSizes.args = {
+  options,
+};
+
+function sleep(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+export const CancelInputTest = {
+  render: (props) => {
+    return (
+      <DemoContainer dataTheme={props.darkMode}>
+        <UNSAFE_Combobox
+          options={options}
+          label="Hva er dine favorittfrukter?"
+        />
+      </DemoContainer>
+    );
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+
+    const input = canvas.getByLabelText("Hva er dine favorittfrukter?");
+
+    userEvent.click(input);
+    await userEvent.type(input, "apple", { delay: 200 });
+    await sleep(1000);
+
+    userEvent.keyboard("{ArrowDown}");
+    await sleep(1000);
+    userEvent.keyboard("{Escape}");
+    await sleep(1000);
+    userEvent.keyboard("{ArrowDown}");
+    const banana = canvas.getByText("banana");
+    userEvent.click(banana);
+  },
+};
+
+export const RemoveSelectedMultiSelectTest = {
+  render: (props) => {
+    return (
+      <DemoContainer dataTheme={props.darkMode}>
+        <UNSAFE_Combobox
+          options={options}
+          label="Hva er dine favorittfrukter?"
+          isMultiSelect
+        />
+      </DemoContainer>
+    );
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+
+    const input = canvas.getByLabelText("Hva er dine favorittfrukter?");
+
+    userEvent.click(input);
+    await userEvent.type(input, "apple", { delay: 200 });
+    await sleep(250);
+
+    userEvent.keyboard("{ArrowDown}");
+    await sleep(250);
+    userEvent.keyboard("{Enter}");
+    await sleep(250);
+    userEvent.keyboard("{Escape}");
+    await sleep(250);
+
+    userEvent.click(input);
+    await userEvent.type(input, "banana", { delay: 200 });
+    await sleep(250);
+
+    userEvent.keyboard("{ArrowDown}");
+    await sleep(250);
+    userEvent.keyboard("{Enter}");
+    await sleep(250);
+    userEvent.keyboard("{Escape}");
+    await sleep(250);
+
+    const appleSlett = canvas.getByLabelText("apple slett");
+    userEvent.click(appleSlett);
+    await sleep(250);
+
+    const bananaSlett = canvas.getByLabelText("banana slett");
+    expect(bananaSlett).toBeInTheDocument();
+    const appleSlettAgain = canvas.queryByLabelText("apple slett");
+    expect(appleSlettAgain).not.toBeInTheDocument();
+  },
+};
+
+export const AddWhenAddNewDisabledTest = {
+  render: (props) => {
+    return (
+      <DemoContainer dataTheme={props.darkMode}>
+        <UNSAFE_Combobox
+          options={options}
+          label="Hva er dine favorittfrukter?"
+          isMultiSelect
+        />
+      </DemoContainer>
+    );
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+
+    const input = canvas.getByLabelText("Hva er dine favorittfrukter?");
+
+    userEvent.click(input);
+    await userEvent.type(input, "aaa", { delay: 200 });
+    await sleep(250);
+
+    userEvent.keyboard("{ArrowDown}");
+    await sleep(250);
+    userEvent.keyboard("{ArrowDown}");
+    await sleep(250);
+    userEvent.keyboard("{Enter}");
+    await sleep(250);
+    userEvent.keyboard("{Escape}");
+    await sleep(250);
+
+    const invalidSelect = canvas.queryByLabelText("aaa slett");
+    expect(invalidSelect).not.toBeInTheDocument();
+  },
+};

package/src/form/combobox/combobox.test.tsx

@@ -0,0 +1,123 @@
+/* eslint-disable react/jsx-pascal-case */
+import { render } from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import React, { useId } from "react";
+import { UNSAFE_Combobox } from "..";
+import { act } from "react-dom/test-utils";
+
+const options = [
+  "banana",
+  "apple",
+  "tangerine",
+  "pear",
+  "grape",
+  "kiwi",
+  "mango",
+  "passion fruit",
+  "pineapple",
+  "strawberry",
+  "watermelon",
+  "grape fruit",
+];
+
+const App = (props) => {
+  const id = useId();
+  return (
+    <div data-theme="light">
+      <UNSAFE_Combobox
+        label="Hva er dine favorittfrukter?"
+        size="medium"
+        variant="simple"
+        id={id}
+        {...props}
+      />
+    </div>
+  );
+};
+
+describe("Render combobox", () => {
+  describe("with multi select", () => {
+    it("Should be able to search, select and remove selections", async () => {
+      const utils = render(<App isMultiSelect options={options} />);
+
+      await act(async () => {
+        await userEvent.click(
+          utils.getByRole("combobox", { name: "Hva er dine favorittfrukter?" })
+        );
+      });
+      await act(async () => {
+        await userEvent.type(
+          utils.getByRole("combobox", { name: "Hva er dine favorittfrukter?" }),
+          "apple"
+        );
+      });
+      await act(async () => {
+        await userEvent.click(
+          await utils.findByRole("option", { name: "apple" })
+        );
+      });
+      expect(
+        await utils.findByRole("option", { name: "apple", selected: true })
+      ).toBeInTheDocument();
+      await act(async () => {
+        await userEvent.click(
+          await utils.findByRole("button", { name: "apple slett" })
+        );
+      });
+    });
+  });
+
+  it("Should show loading icon when loading (used for async search)", async () => {
+    const utils = render(<App options={[]} isListOpen isLoading />);
+
+    expect(await utils.findByRole("option", { name: "venter..." }));
+  });
+});
+
+describe("Combobox state-handling", () => {
+  it("Should not select previous focused element when closes", async () => {
+    const utils = render(<App options={options} />);
+
+    await act(async () => {
+      await userEvent.click(
+        utils.getByRole("combobox", { name: "Hva er dine favorittfrukter?" })
+      );
+    });
+    await act(async () => {
+      await userEvent.type(
+        utils.getByRole("combobox", { name: "Hva er dine favorittfrukter?" }),
+        "ban"
+      );
+      await userEvent.keyboard("{ArrowDown}");
+      await userEvent.keyboard("{ArrowUp}");
+      await userEvent.keyboard("{Enter}");
+    });
+
+    expect(
+      await utils.queryByRole("button", { name: "banana slett" })
+    ).toBeNull();
+  });
+
+  it("Should reset list when resetting input (ESC)", async () => {
+    const utils = render(<App options={options} />);
+
+    await act(async () => {
+      await userEvent.click(
+        utils.getByRole("combobox", { name: "Hva er dine favorittfrukter?" })
+      );
+    });
+    await act(async () => {
+      await userEvent.type(
+        utils.getByRole("combobox", { name: "Hva er dine favorittfrukter?" }),
+        "apple"
+      );
+      await userEvent.keyboard("{ArrowDown}");
+      await userEvent.keyboard("{Escape}");
+      await userEvent.keyboard("{ArrowDown}");
+    });
+
+    expect(
+      await utils.findByRole("option", { name: "banana" })
+    ).toBeInTheDocument();
+  });
+});