@sit-onyx/headless 1.0.0-beta.2 → 1.0.0-beta.21

package/README.md

@@ -1,9 +1,5 @@
 <div align="center" style="text-align: center">
-  <picture>
-    <source media="(prefers-color-scheme: dark)" type="image/svg+xml" srcset="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo-light.svg">
-    <source media="(prefers-color-scheme: light)" type="image/svg+xml" srcset="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo-dark.svg">
-    <img alt="onyx logo" src="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo-dark.svg" width="160px">
-  </picture>
+  <img alt="onyx logo" src="https://raw.githubusercontent.com/SchwarzIT/onyx/main/.github/onyx-logo.svg" height="96px">
 </div>
 
 <br>

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@sit-onyx/headless",
   "description": "Headless composables for Vue",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.21",
   "type": "module",
   "author": "Schwarz IT KG",
   "license": "Apache-2.0",
+  "engines": {
+    "node": ">=20"
+  },
   "files": [
     "src"
   ],
@@ -24,11 +27,16 @@
   },
   "peerDependencies": {
     "typescript": ">= 5",
-    "vue": ">= 3"
+    "vue": ">= 3.5.0"
+  },
+  "devDependencies": {
+    "@vue/compiler-dom": "3.5.16",
+    "vue": "3.5.16",
+    "@sit-onyx/shared": "^1.0.0-beta.4"
   },
   "scripts": {
     "build": "vue-tsc --build --force",
     "test": "vitest",
-    "test:components": "playwright install && playwright test"
+    "test:playwright": "playwright install && playwright test"
   }
 }

package/src/composables/comboBox/SelectOnlyCombobox.vue

@@ -1,10 +1,10 @@
 <script setup lang="ts">
-import { computed, ref } from "vue";
-import { createComboBox } from "./createComboBox";
+import { computed, ref, useTemplateRef } from "vue";
+import { createComboBox } from "./createComboBox.js";
 
 const options = ["a", "b", "c", "d"];
 const isExpanded = ref(false);
-const comboboxRef = ref<HTMLElement>();
+const comboboxRef = useTemplateRef("combobox");
 const activeOption = ref("");
 const selectedOption = ref("");
 const selectedIndex = computed<number | undefined>(() => {
@@ -26,7 +26,6 @@ const onToggle = () => (isExpanded.value = !isExpanded.value);
 const onTypeAhead = () => {};
 
 const comboBox = createComboBox({
-  inputValue: selectedOption,
   autocomplete: "none",
   label: "some label",
   listLabel: "List",
@@ -50,14 +49,19 @@ defineExpose({ comboBox });
 </script>
 
 <template>
-  <div ref="comboboxRef">
-    <input v-bind="input" readonly @keydown.arrow-down="isExpanded = true" />
+  <div ref="combobox">
+    <input
+      v-bind="input"
+      v-model="selectedOption"
+      readonly
+      @keydown.arrow-down="isExpanded = true"
+    />
 
-    <button v-bind="button">
+    <button v-bind="button" type="button">
       <template v-if="isExpanded">⬆️</template>
       <template v-else>⬇️</template>
     </button>
-    <ul v-bind="listbox" :class="{ hidden: !isExpanded }" style="width: 400px">
+    <ul class="listbox" v-bind="listbox" :class="{ hidden: !isExpanded }">
       <li
         v-for="e in options"
         :key="e"
@@ -80,4 +84,7 @@ defineExpose({ comboBox });
 [aria-selected="true"] {
   background-color: red;
 }
+.listbox {
+  width: 400px;
+}
 </style>

package/src/composables/comboBox/TestCombobox.ct.tsx

@@ -1,5 +1,5 @@
 import { test } from "@playwright/experimental-ct-vue";
-import { comboboxSelectOnlyTesting, comboboxTesting } from "./createComboBox.testing";
+import { comboboxSelectOnlyTesting, comboboxTesting } from "./createComboBox.testing.js";
 import SelectOnlyCombobox from "./SelectOnlyCombobox.vue";
 import TestCombobox from "./TestCombobox.vue";
 

package/src/composables/comboBox/TestCombobox.vue

@@ -1,11 +1,11 @@
 <script setup lang="ts">
-import { computed, ref } from "vue";
-import { createComboBox } from "./createComboBox";
+import { computed, ref, useTemplateRef } from "vue";
+import { createComboBox } from "./createComboBox.js";
 
 const options = ["a", "b", "c", "d"];
 const isExpanded = ref(false);
 const searchTerm = ref("");
-const comboboxRef = ref<HTMLElement>();
+const comboboxRef = useTemplateRef("combobox");
 const activeOption = ref("");
 const filteredOptions = computed(() => options.filter((v) => v.includes(searchTerm.value)));
 const selectedIndex = computed<number | undefined>(() => {
@@ -30,7 +30,6 @@ const onAutocomplete = (input: string) => (searchTerm.value = input);
 const onToggle = () => (isExpanded.value = !isExpanded.value);
 
 const comboBox = createComboBox({
-  inputValue: searchTerm,
   autocomplete: "list",
   label: "some label",
   listLabel: "List",
@@ -54,14 +53,14 @@ defineExpose({ comboBox });
 </script>
 
 <template>
-  <div ref="comboboxRef">
-    <input v-bind="input" @keydown.arrow-down="isExpanded = true" />
+  <div ref="combobox">
+    <input v-bind="input" v-model="searchTerm" @keydown.arrow-down="isExpanded = true" />
 
-    <button v-bind="button">
-      <template v-if="isExpanded">⬆️</template>
-      <template v-else>⬇️</template>
+    <button v-bind="button" type="button">
+      <template v-if="isExpanded"> ⬆️ </template>
+      <template v-else> ⬇️ </template>
     </button>
-    <ul v-bind="listbox" :class="{ hidden: !isExpanded }" style="width: 400px">
+    <ul v-bind="listbox" :class="{ list: true, hidden: !isExpanded }">
       <li
         v-for="e in filteredOptions"
         :key="e"
@@ -75,6 +74,10 @@ defineExpose({ comboBox });
 </template>
 
 <style>
+.list {
+  width: 400px;
+}
+
 .hidden {
   display: none;
 }

package/src/composables/comboBox/createComboBox.ts

@@ -1,15 +1,16 @@
-import { computed, unref, type MaybeRef, type Ref } from "vue";
-import { createBuilder } from "../../utils/builder";
-import { createId } from "../../utils/id";
-import { isPrintableCharacter, wasKeyPressed, type PressedKey } from "../../utils/keyboard";
-import { useOutsideClick } from "../helpers/useOutsideClick";
-import { useTypeAhead } from "../helpers/useTypeAhead";
+import { computed, unref, useId, type MaybeRef, type Ref } from "vue";
+import { createBuilder } from "../../utils/builder.js";
+import { isPrintableCharacter, wasKeyPressed, type PressedKey } from "../../utils/keyboard.js";
+import type { Nullable } from "../../utils/types.js";
+import { useOutsideClick } from "../helpers/useOutsideClick.js";
+import { useTypeAhead } from "../helpers/useTypeAhead.js";
 import {
   createListbox,
   type CreateListboxOptions,
   type ListboxValue,
-} from "../listbox/createListbox";
+} from "../listbox/createListbox.js";
 
+/** See https://w3c.github.io/aria/#aria-autocomplete */
 export type ComboboxAutoComplete = "none" | "list" | "both";
 
 export const OPENING_KEYS: PressedKey[] = ["ArrowDown", "ArrowUp", " ", "Enter", "Home", "End"];
@@ -19,11 +20,15 @@ export const CLOSING_KEYS: PressedKey[] = [
   "Enter",
   "Tab",
 ];
-const SELECTING_KEYS_SINGLE: PressedKey[] = ["Enter", " "];
-const SELECTING_KEYS_MULTIPLE: PressedKey[] = ["Enter"];
 
-const isSelectingKey = (event: KeyboardEvent, isMultiselect?: boolean) => {
-  const selectingKeys = isMultiselect ? SELECTING_KEYS_MULTIPLE : SELECTING_KEYS_SINGLE;
+const SELECTING_KEYS: PressedKey[] = ["Enter"];
+
+/**
+ * if the a search input is included, space should not be used to select
+ * TODO: idea for the future: move this distinction to the listbox?
+ */
+const isSelectingKey = (event: KeyboardEvent, withSpace?: boolean) => {
+  const selectingKeys = withSpace ? [...SELECTING_KEYS, " "] : SELECTING_KEYS;
   return isKeyOfGroup(event, selectingKeys);
 };
 
@@ -42,9 +47,9 @@ export type CreateComboboxOptions<
    */
   listLabel: MaybeRef<string>;
   /**
-   * The current value of the combobox. Is updated when an option from the controlled listbox is selected or by typing into it.
+   * Provides additional description for the listbox which displays the available options.
    */
-  inputValue: Ref<string | undefined>;
+  listDescription?: MaybeRef<Nullable<string>>;
   /**
    * Controls the opened/visible state of the associated pop-up. When expanded the activeOption can be controlled via the keyboard.
    */
@@ -52,11 +57,11 @@ export type CreateComboboxOptions<
   /**
    * If expanded, the active option is the currently highlighted option of the controlled listbox.
    */
-  activeOption: Ref<TValue | undefined>;
+  activeOption: Ref<Nullable<TValue>>;
   /**
    * Template ref to the component root (required to close combobox on outside click).
    */
-  templateRef: Ref<HTMLElement | undefined>;
+  templateRef: Ref<Nullable<HTMLElement>>;
   /**
    * Hook when the popover should toggle.
    *
@@ -105,13 +110,13 @@ export const createComboBox = createBuilder(
     TAutoComplete extends ComboboxAutoComplete,
     TMultiple extends boolean = false,
   >({
-    inputValue,
     autocomplete: autocompleteRef,
     onAutocomplete,
     onTypeAhead,
     multiple: multipleRef,
     label,
     listLabel,
+    listDescription,
     isExpanded: isExpandedRef,
     activeOption,
     onToggle,
@@ -122,7 +127,7 @@ export const createComboBox = createBuilder(
     onActivatePrevious,
     templateRef,
   }: CreateComboboxOptions<TValue, TAutoComplete, TMultiple>) => {
-    const controlsId = createId("comboBox-control");
+    const controlsId = useId();
 
     const autocomplete = computed(() => unref(autocompleteRef));
     const isExpanded = computed(() => unref(isExpandedRef));
@@ -188,7 +193,7 @@ export const createComboBox = createBuilder(
         }
         return onActivateFirst?.();
       }
-      if (isSelectingKey(event, multiple.value)) {
+      if (isSelectingKey(event, autocomplete.value === "none")) {
         return handleSelect(activeOption.value!);
       }
       if (isExpanded.value && isKeyOfGroup(event, CLOSING_KEYS)) {
@@ -205,27 +210,29 @@ export const createComboBox = createBuilder(
       return handleNavigation(event);
     };
 
-    const autocompleteInput =
-      autocomplete.value !== "none"
-        ? {
-            "aria-autocomplete": autocomplete.value,
-            type: "text",
-          }
-        : null;
+    const autocompleteInput = computed(() => {
+      if (autocomplete.value === "none") return null;
+      return {
+        "aria-autocomplete": autocomplete.value,
+        type: "text",
+      };
+    });
 
     const {
       elements: { option, group, listbox },
       internals: { getOptionId },
     } = createListbox({
       label: listLabel,
+      description: listDescription,
       multiple,
       controlled: true,
       activeOption,
+      isExpanded,
       onSelect: handleSelect,
     });
 
     useOutsideClick({
-      element: templateRef,
+      inside: templateRef,
       onOutsideClick() {
         if (!isExpanded.value) return;
         onToggle?.(true);
@@ -250,7 +257,6 @@ export const createComboBox = createBuilder(
          * The input MAY be either a single-line text field that supports editing and typing or an element that only displays the current value of the combobox.
          */
         input: computed(() => ({
-          value: inputValue.value,
           role: "combobox",
           "aria-expanded": isExpanded.value,
           "aria-controls": controlsId,
@@ -259,7 +265,7 @@ export const createComboBox = createBuilder(
             activeOption.value != undefined ? getOptionId(activeOption.value) : undefined,
           onInput: handleInput,
           onKeydown: handleKeydown,
-          ...autocompleteInput,
+          ...autocompleteInput.value,
         })),
         /**
          * An optional button to control the visibility of the popup.

package/src/composables/helpers/useDismissible.ts

@@ -0,0 +1,19 @@
+import { computed, type Ref } from "vue";
+import { useGlobalEventListener } from "./useGlobalListener.js";
+
+type UseDismissibleOptions = { isExpanded: Ref<boolean> };
+
+/**
+ * Composable that sets `isExpanded` to false, when the `Escape` key is pressed.
+ * Addresses the "dismissible" aspect of https://www.w3.org/WAI/WCAG21/Understanding/content-on-hover-or-focus.html
+ */
+export const useDismissible = ({ isExpanded }: UseDismissibleOptions) =>
+  useGlobalEventListener({
+    type: "keydown",
+    listener: (e) => {
+      if (e.key === "Escape") {
+        isExpanded.value = false;
+      }
+    },
+    disabled: computed(() => !isExpanded.value),
+  });

package/src/composables/helpers/useGlobalListener.spec.ts

@@ -1,7 +1,7 @@
 import { beforeEach, describe, expect, it, vi } from "vitest";
 import { ref, type Ref } from "vue";
-import { mockVueLifecycle } from "../../utils/vitest";
-import { useGlobalEventListener } from "./useGlobalListener";
+import { mockVueLifecycle } from "../../utils/vitest.js";
+import { useGlobalEventListener } from "./useGlobalListener.js";
 
 let unmount: () => Promise<void> | undefined;
 

package/src/composables/helpers/useGlobalListener.ts

@@ -3,7 +3,7 @@ import { onBeforeMount, onBeforeUnmount, reactive, watchEffect, type Ref } from
 type DocumentEventType = keyof DocumentEventMap;
 type GlobalListener<K extends DocumentEventType = DocumentEventType> = (
   event: DocumentEventMap[K],
-) => void;
+) => unknown;
 
 export type UseGlobalEventListenerOptions<K extends DocumentEventType> = {
   type: K;

package/src/composables/helpers/useOutsideClick.spec.ts

@@ -0,0 +1,117 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { ref } from "vue";
+import { mockVueLifecycle } from "../../utils/vitest.js";
+import { useOutsideClick } from "./useOutsideClick.js";
+
+describe("useOutsideClick", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockVueLifecycle();
+  });
+
+  it("should be defined", () => {
+    expect(useOutsideClick).toBeDefined();
+  });
+
+  it("should detect outside clicks", async () => {
+    // ARRANGE
+    vi.useFakeTimers();
+    const inside = ref(document.createElement("button"));
+    document.body.appendChild(inside.value);
+    const outside = ref(document.createElement("button"));
+    document.body.appendChild(outside.value);
+
+    const onOutsideClick = vi.fn();
+    useOutsideClick({ inside, onOutsideClick });
+
+    // ACT
+    const event = new MouseEvent("mousedown", { bubbles: true });
+    outside.value.dispatchEvent(event);
+
+    // ASSERT
+    expect(onOutsideClick).toHaveBeenCalledTimes(1);
+    expect(onOutsideClick).toBeCalledWith(event);
+
+    // ACT
+    outside.value.dispatchEvent(new KeyboardEvent("keydown", { bubbles: true, key: "Tab" }));
+    await vi.runAllTimersAsync();
+
+    // ASSERT
+    expect(
+      onOutsideClick,
+      "should not trigger on Tab press when checkOnTab option is disabled",
+    ).toHaveBeenCalledTimes(1);
+  });
+
+  it("should detect outside clicks correctly for multiple inside elements", () => {
+    // ARRANGE
+    const inside = [document.createElement("button"), document.createElement("button")];
+    inside.forEach((e) => document.body.appendChild(e));
+    const outside = ref(document.createElement("button"));
+    document.body.appendChild(outside.value);
+
+    const onOutsideClick = vi.fn();
+    useOutsideClick({ inside, onOutsideClick });
+    // ACT
+    const event = new MouseEvent("mousedown", { bubbles: true });
+    inside[0].dispatchEvent(event);
+    inside[1].dispatchEvent(event);
+    // ASSERT
+    expect(onOutsideClick).not.toHaveBeenCalled();
+
+    // ACT
+    outside.value.dispatchEvent(event);
+    // ASSERT
+    expect(onOutsideClick).toHaveBeenCalledTimes(1);
+    expect(onOutsideClick).toBeCalledWith(event);
+  });
+
+  it("should ignore outside clicks when disabled", async () => {
+    // ARRANGE
+    vi.useFakeTimers();
+    const inside = ref(document.createElement("button"));
+    document.body.appendChild(inside.value);
+    const outside = ref(document.createElement("button"));
+    document.body.appendChild(outside.value);
+
+    const disabled = ref(false);
+    const onOutsideClick = vi.fn();
+    useOutsideClick({ inside, disabled, onOutsideClick });
+
+    // ACT
+    const event = new MouseEvent("mousedown", { bubbles: true });
+    outside.value.dispatchEvent(event);
+    // ASSERT
+    expect(onOutsideClick).toHaveBeenCalledTimes(1);
+    expect(onOutsideClick).toBeCalledWith(event);
+
+    // ACT
+    disabled.value = true;
+    await vi.runAllTimersAsync();
+    const event2 = new MouseEvent("mousedown", { bubbles: true });
+    outside.value.dispatchEvent(event2);
+    // ASSERT
+    expect(onOutsideClick).toHaveBeenCalledTimes(1);
+  });
+
+  it("should detect outside tab via keyboard", async () => {
+    // ARRANGE
+    vi.useFakeTimers();
+    const inside = ref(document.createElement("button"));
+    document.body.appendChild(inside.value);
+    const outside = ref(document.createElement("button"));
+    document.body.appendChild(outside.value);
+
+    const onOutsideClick = vi.fn();
+    useOutsideClick({ inside, onOutsideClick, checkOnTab: true });
+
+    // ACT
+    const event = new KeyboardEvent("keydown", { bubbles: true, key: "Tab" });
+    outside.value.dispatchEvent(event);
+    await vi.runAllTimersAsync();
+
+    // ASSERT
+    expect(onOutsideClick).toHaveBeenCalledTimes(1);
+    expect(onOutsideClick).toBeCalledWith(event);
+  });
+});

package/src/composables/helpers/useOutsideClick.ts

@@ -1,15 +1,23 @@
-import { type Ref } from "vue";
-import { useGlobalEventListener } from "./useGlobalListener";
+import type { Arrayable } from "vitest"; // For an unknown reason removing this import will break the build of "demo-app" and "playground"
+import { toValue, type MaybeRefOrGetter, type Ref } from "vue";
+import type { Nullable } from "../../utils/types.js";
+import { useGlobalEventListener } from "./useGlobalListener.js";
 
-export type UseOutsideClickOptions = {
+export type UseOutsideClickOptions<TCheckOnTab extends boolean | undefined = undefined> = {
   /**
    * HTML element of the component where clicks should be ignored
    */
-  element: Ref<HTMLElement | undefined>;
+  inside: MaybeRefOrGetter<Arrayable<Nullable<HTMLElement>>>;
   /**
    * Callback when an outside click occurred.
    */
-  onOutsideClick: () => void;
+  onOutsideClick: (
+    event: TCheckOnTab extends true ? MouseEvent | KeyboardEvent : MouseEvent,
+  ) => void;
+  /**
+   * Whether the outside focus should also be checked when pressing the Tab key.
+   */
+  checkOnTab?: TCheckOnTab;
   /**
    * If `true`, event listeners will be removed and no outside clicks will be captured.
    */
@@ -20,15 +28,42 @@ export type UseOutsideClickOptions = {
  * Composable for listening to click events that occur outside of a component.
  * Useful to e.g. close flyouts or tooltips.
  */
-export const useOutsideClick = ({ element, onOutsideClick, disabled }: UseOutsideClickOptions) => {
+export const useOutsideClick = <TCheckOnTab extends boolean | undefined>({
+  inside,
+  onOutsideClick,
+  disabled,
+  checkOnTab,
+}: UseOutsideClickOptions<TCheckOnTab>) => {
+  const isOutsideClick = (target: EventTarget | null) => {
+    if (!target) return true;
+    const raw = toValue(inside);
+    const elements = Array.isArray(raw) ? raw : [raw];
+    return !elements.some((element) => element?.contains(target as Node | null));
+  };
+
   /**
    * Document click handle that closes then tooltip when clicked outside.
    * Should only be called when trigger is "click".
    */
-  const listener = ({ target }: MouseEvent) => {
-    const isOutsideClick = !element.value?.contains(target as HTMLElement);
-    if (isOutsideClick) onOutsideClick();
+  const clickListener = (event: MouseEvent) => {
+    if (isOutsideClick(event.target)) onOutsideClick(event);
   };
 
-  useGlobalEventListener({ type: "click", listener, disabled });
+  useGlobalEventListener({ type: "mousedown", listener: clickListener, disabled });
+
+  if (checkOnTab) {
+    const keydownListener = async (event: KeyboardEvent) => {
+      if (event.key !== "Tab") return;
+
+      // using setTimeout here to guarantee that side effects that might change the document.activeElement have run before checking
+      // the activeElement
+      await new Promise((resolve) => setTimeout(resolve));
+
+      if (isOutsideClick(document.activeElement)) {
+        onOutsideClick(event as Parameters<typeof onOutsideClick>[0]);
+      }
+    };
+
+    useGlobalEventListener({ type: "keydown", listener: keydownListener, disabled });
+  }
 };

package/src/composables/helpers/useTypeAhead.spec.ts

@@ -1,5 +1,5 @@
 import { beforeAll, expect, test, vi } from "vitest";
-import { useTypeAhead } from "./useTypeAhead";
+import { useTypeAhead } from "./useTypeAhead.js";
 
 beforeAll(() => {
   vi.useFakeTimers();

package/src/composables/helpers/useTypeAhead.ts

@@ -1,5 +1,5 @@
-import { isPrintableCharacter } from "../../utils/keyboard";
-import { debounce } from "../../utils/timer";
+import { isPrintableCharacter } from "../../utils/keyboard.js";
+import { debounce } from "../../utils/timer.js";
 
 /**
  * Enhances typeAhead to combine multiple inputs in quick succession and filter out non-printable characters.

package/src/composables/listbox/TestListbox.ct.tsx

@@ -1,6 +1,6 @@
 import { test } from "@playwright/experimental-ct-vue";
 import TestListbox from "./TestListbox.vue";
-import { listboxTesting } from "./createListbox.testing";
+import { listboxTesting } from "./createListbox.testing.js";
 
 test("listbox", async ({ mount, page }) => {
   await mount(<TestListbox />);

package/src/composables/listbox/TestListbox.vue

@@ -1,6 +1,6 @@
 <script lang="ts" setup>
 import { ref } from "vue";
-import { createListbox } from "./createListbox";
+import { createListbox } from "./createListbox.js";
 
 type Options = (typeof options)[number];
 
@@ -30,7 +30,9 @@ const {
   elements: { listbox, option: headlessOption },
 } = createListbox({
   label: "Test listbox",
+  description: "Test description",
   activeOption,
+  isExpanded: true,
   onSelect: (id) => {
     selectedOption.value = selectedOption.value === id ? undefined : id;
   },