@sit-onyx/headless 1.0.0-beta.1 → 1.0.0-beta.11

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sit-onyx/headless",
   "description": "Headless composables for Vue",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "type": "module",
   "author": "Schwarz IT KG",
   "license": "Apache-2.0",
@@ -24,7 +24,11 @@
   },
   "peerDependencies": {
     "typescript": ">= 5",
-    "vue": ">= 3"
+    "vue": ">= 3.5.0"
+  },
+  "devDependencies": {
+    "@vue/compiler-dom": "3.5.12",
+    "vue": "3.5.12"
   },
   "scripts": {
     "build": "vue-tsc --build --force",

package/src/composables/comboBox/SelectOnlyCombobox.vue

@@ -26,7 +26,6 @@ const onToggle = () => (isExpanded.value = !isExpanded.value);
 const onTypeAhead = () => {};
 
 const comboBox = createComboBox({
-  inputValue: selectedOption,
   autocomplete: "none",
   label: "some label",
   listLabel: "List",
@@ -51,7 +50,12 @@ defineExpose({ comboBox });
 
 <template>
   <div ref="comboboxRef">
-    <input v-bind="input" readonly @keydown.arrow-down="isExpanded = true" />
+    <input
+      v-bind="input"
+      v-model="selectedOption"
+      readonly
+      @keydown.arrow-down="isExpanded = true"
+    />
 
     <button v-bind="button">
       <template v-if="isExpanded">⬆️</template>

package/src/composables/comboBox/TestCombobox.vue

@@ -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",
@@ -55,13 +54,13 @@ defineExpose({ comboBox });
 
 <template>
   <div ref="comboboxRef">
-    <input v-bind="input" @keydown.arrow-down="isExpanded = true" />
+    <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,6 +1,5 @@
-import { computed, unref, type MaybeRef, type Ref } from "vue";
+import { computed, unref, useId, 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";
@@ -10,6 +9,7 @@ import {
   type ListboxValue,
 } from "../listbox/createListbox";
 
+/** 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 +19,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 +46,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<string | undefined>;
   /**
    * Controls the opened/visible state of the associated pop-up. When expanded the activeOption can be controlled via the keyboard.
    */
@@ -105,13 +109,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 +126,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 +192,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)) {
@@ -218,14 +222,16 @@ export const createComboBox = createBuilder(
       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 +256,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,

package/src/composables/helpers/useDismissible.ts

@@ -0,0 +1,19 @@
+import { computed, type Ref } from "vue";
+import { useGlobalEventListener } from "./useGlobalListener";
+
+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/useOutsideClick.spec.ts

@@ -0,0 +1,83 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { ref } from "vue";
+import { mockVueLifecycle } from "../../utils/vitest";
+import { useOutsideClick } from "./useOutsideClick";
+
+describe("useOutsideClick", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockVueLifecycle();
+  });
+
+  it("should be defined", () => {
+    expect(useOutsideClick).toBeDefined();
+  });
+
+  it("should detect outside clicks", () => {
+    // ARRANGE
+    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("click", { bubbles: true });
+    outside.value.dispatchEvent(event);
+    // ASSERT
+    expect(onOutsideClick).toHaveBeenCalledTimes(1);
+    expect(onOutsideClick).toBeCalledWith(event);
+  });
+
+  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("click", { 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("click", { 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("click", { bubbles: true });
+    outside.value.dispatchEvent(event2);
+    // ASSERT
+    expect(onOutsideClick).toHaveBeenCalledTimes(1);
+  });
+});

package/src/composables/helpers/useOutsideClick.ts

@@ -1,15 +1,17 @@
-import { type Ref } from "vue";
+import type { Arrayable } from "vitest";
+import { toValue, type Ref } from "vue";
+import type { MaybeReactiveSource } from "../../utils/types";
 import { useGlobalEventListener } from "./useGlobalListener";
 
 export type UseOutsideClickOptions = {
   /**
    * HTML element of the component where clicks should be ignored
    */
-  element: Ref<HTMLElement | undefined>;
+  inside: MaybeReactiveSource<Arrayable<HTMLElement | undefined>>;
   /**
    * Callback when an outside click occurred.
    */
-  onOutsideClick: () => void;
+  onOutsideClick: (event: MouseEvent) => void;
   /**
    * If `true`, event listeners will be removed and no outside clicks will be captured.
    */
@@ -20,14 +22,18 @@ 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 = ({ inside, onOutsideClick, disabled }: UseOutsideClickOptions) => {
   /**
    * 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 listener = (event: MouseEvent) => {
+    const raw = toValue(inside);
+    const elements = Array.isArray(raw) ? raw : [raw];
+    const isOutsideClick = !elements.some((element) =>
+      element?.contains(event.target as HTMLElement),
+    );
+    if (isOutsideClick) onOutsideClick(event);
   };
 
   useGlobalEventListener({ type: "click", listener, disabled });

package/src/composables/listbox/TestListbox.vue

@@ -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;
   },

package/src/composables/listbox/createListbox.ts

@@ -1,6 +1,5 @@
-import { computed, ref, unref, watchEffect, type MaybeRef, type Ref } from "vue";
-import { createId } from "../..";
-import { createBuilder, type HeadlessElementAttributes } from "../../utils/builder";
+import { computed, nextTick, ref, unref, useId, watchEffect, type MaybeRef, type Ref } from "vue";
+import { createBuilder, type VBindAttributes } from "../../utils/builder";
 import { useTypeAhead } from "../helpers/useTypeAhead";
 
 export type ListboxValue = string | number | boolean;
@@ -10,6 +9,10 @@ export type CreateListboxOptions<TValue extends ListboxValue, TMultiple extends
    * Aria label for the listbox.
    */
   label: MaybeRef<string>;
+  /**
+   * Aria description for the listbox.
+   */
+  description?: MaybeRef<string | undefined>;
   /**
    * Value of currently (visually) active option.
    */
@@ -19,6 +22,10 @@ export type CreateListboxOptions<TValue extends ListboxValue, TMultiple extends
    * This disables keyboard events and makes the listbox not focusable.
    */
   controlled?: boolean;
+  /**
+   * Controls the opened/visible state of the listbox. When expanded the activeOption can be controlled via the keyboard.
+   */
+  isExpanded?: MaybeRef<boolean>;
   /**
    * Whether the listbox is multiselect.
    */
@@ -77,6 +84,7 @@ export const createListbox = createBuilder(
     options: CreateListboxOptions<TValue, TMultiple>,
   ) => {
     const isMultiselect = computed(() => unref(options.multiple) ?? false);
+    const isExpanded = computed(() => unref(options.isExpanded) ?? false);
 
     /**
      * Map for option IDs. key = option value, key = ID for the HTML element
@@ -85,7 +93,7 @@ export const createListbox = createBuilder(
 
     const getOptionId = (value: TValue) => {
       if (!descendantKeyIdMap.has(value)) {
-        descendantKeyIdMap.set(value, createId("listbox-option"));
+        descendantKeyIdMap.set(value, useId());
       }
       return descendantKeyIdMap.get(value)!;
     };
@@ -96,11 +104,18 @@ export const createListbox = createBuilder(
     const isFocused = ref(false);
 
     // scroll currently active option into view if needed
-    watchEffect(() => {
-      if (options.activeOption.value == undefined || (!isFocused.value && !options.controlled))
+    watchEffect(async () => {
+      if (
+        !isExpanded.value ||
+        options.activeOption.value == undefined ||
+        (!isFocused.value && !options.controlled)
+      )
         return;
       const id = getOptionId(options.activeOption.value);
-      document.getElementById(id)?.scrollIntoView({ block: "nearest", inline: "nearest" });
+
+      await nextTick(() => {
+        document.getElementById(id)?.scrollIntoView({ block: "end", inline: "nearest" });
+      });
     });
 
     const typeAhead = useTypeAhead((inputString) => options.onTypeAhead?.(inputString));
@@ -152,18 +167,20 @@ export const createListbox = createBuilder(
       }
     };
 
-    const listbox = computed<HeadlessElementAttributes>(() =>
+    const listbox = computed<VBindAttributes>(() =>
       options.controlled
         ? {
             role: "listbox",
             "aria-multiselectable": isMultiselect.value,
             "aria-label": unref(options.label),
+            "aria-description": options.description,
             tabindex: "-1",
           }
         : {
             role: "listbox",
             "aria-multiselectable": isMultiselect.value,
             "aria-label": unref(options.label),
+            "aria-description": options.description,
             tabindex: "0",
             "aria-activedescendant":
               options.activeOption.value != undefined

package/src/composables/menuButton/TestMenuButton.ct.tsx

@@ -9,6 +9,6 @@ test("menuButton", async ({ mount, page }) => {
     page,
     button: page.getByRole("button"),
     menu: page.locator("ul"),
-    menuItems: await page.locator("li").all(),
+    menuItems: page.getByRole("menuitem"),
   });
 });

package/src/composables/menuButton/TestMenuButton.vue

@@ -8,18 +8,19 @@ const items = Array.from({ length: 10 }, (_, index) => {
 });
 
 const activeItem = ref<string>();
+const isExpanded = ref(false);
+const onToggle = () => (isExpanded.value = !isExpanded.value);
 
 const {
-  elements: { button, menu, menuItem, listItem, flyout },
-  state: { isExpanded },
-} = createMenuButton();
+  elements: { root, button, menu, menuItem, listItem },
+} = createMenuButton({ isExpanded, onToggle });
 </script>
 
 <template>
-  <button v-bind="button">Toggle nav menu</button>
-  <div v-bind="flyout">
+  <div v-bind="root">
+    <button v-bind="button">Toggle nav menu</button>
     <ul v-show="isExpanded" v-bind="menu">
-      <li v-for="item in items" v-bind="listItem" :key="item.value" title="item">
+      <li v-for="item in items" v-bind="listItem" :key="item.value">
         <a v-bind="menuItem({ active: activeItem === item.value })" href="#">{{ item.label }}</a>
       </li>
     </ul>

package/src/composables/menuButton/createMenuButton.testing.ts

@@ -17,7 +17,7 @@ export type MenuButtonTestingOptions = {
   /**
    * List items (at least 3).
    */
-  menuItems: Locator[];
+  menuItems: Locator;
 };
 
 /**
@@ -45,25 +45,26 @@ export const menuButtonTesting = async ({
   await expect(button).toBeVisible();
 
   // ensure correct navigation menu aria attributes
-  await expect(
-    button,
-    'flyout menu must have an "aria-expanded" attribute set to false',
-  ).toHaveAttribute("aria-expanded", "false");
-
-  button.hover();
-
-  await expect(
-    button,
-    'flyout menu must have an "aria-expanded" attribute set to true',
-  ).toHaveAttribute("aria-expanded", "true");
-
-  const firstItem = menuItems[0].getByRole("menuitem");
-  const secondItem = menuItems[1].getByRole("menuitem");
-  const lastItem = menuItems[menuItems.length - 1].getByRole("menuitem");
+  await expect(button, "button must have arial-controls attribute").toHaveAttribute(
+    "aria-controls",
+  );
+  await expect(button, "button must have aria-expanded attribute").toHaveAttribute(
+    "aria-expanded",
+    "false",
+  );
 
   await page.keyboard.press("Tab");
   await expect(button, "Button should be focused when pressing tab key").toBeFocused();
 
+  const firstItem = menuItems.first();
+  const secondItem = menuItems.nth(1);
+  const lastItem = menuItems.last();
+
+  await page.keyboard.press("Enter");
+  await expect(button, "button must have aria-expanded attribute").toHaveAttribute(
+    "aria-expanded",
+    "true",
+  );
   await button.press("ArrowDown");
   await expect(
     firstItem,