@sit-onyx/headless 0.0.0 → 0.1.0-alpha.0

package/README.md

@@ -6,7 +6,7 @@
   </a>
 </p>
 
-# Onyx Headless
+# onyx Headless
 
 A composable headless library for Vue created by [Schwarz IT](https://it.schwarz).
 

package/package.json

@@ -1,13 +1,19 @@
 {
   "name": "@sit-onyx/headless",
   "description": "Headless composables for Vue",
-  "version": "0.0.0",
+  "version": "0.1.0-alpha.0",
   "type": "module",
   "author": "Schwarz IT KG",
   "license": "Apache-2.0",
+  "files": [
+    "src"
+  ],
   "exports": {
     ".": {
       "default": "./src/index.ts"
+    },
+    "./playwright": {
+      "default": "./src/playwright.ts"
     }
   },
   "peerDependencies": {
@@ -15,6 +21,7 @@
     "vue": ">= 3"
   },
   "scripts": {
-    "build": "tsc --noEmit"
+    "build": "vue-tsc --build --force",
+    "test:components": "playwright install && playwright test"
   }
 }

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

@@ -0,0 +1,91 @@
+import { expect, test } from "@playwright/experimental-ct-vue";
+import type { Locator, Page } from "@playwright/test";
+import TestDropdown from "./TestDropdown.vue";
+
+const expectToHaveFocus = async (
+  locator: Locator,
+  messageOptions?: Parameters<typeof expect>[1],
+) => {
+  const result = await locator.evaluateHandle((element) => element === document.activeElement);
+  await expect(result.jsonValue(), messageOptions).resolves.toBeTruthy();
+};
+
+test("combobox", async ({ mount, page }) => {
+  await mount(<TestDropdown />);
+  const listbox = page.getByRole("listbox");
+  const combobox = page.getByRole("combobox");
+  const button = page.getByRole("button");
+  const options = page.getByRole("option");
+
+  await comboboxTesting(page, listbox, combobox, button, options);
+});
+
+/**
+ * Test an implementation of the combobox based on https://w3c.github.io/aria/#combobox
+ */
+export const comboboxTesting = async (
+  page: Page,
+  listbox: Locator,
+  combobox: Locator,
+  button: Locator,
+  options: Locator,
+) => {
+  await expect(listbox, "Typically, the initial state of a combobox is collapsed.").toBeHidden();
+
+  await expect(combobox, "In the collapsed state, the combobox element is visible.").toBeVisible();
+  await expect(
+    button,
+    "In the collapsed state, the optional button element is visible.",
+  ).toBeVisible();
+
+  await button.click(); // toggle to be expanded
+  await expect(
+    combobox,
+    "A combobox is said to be expanded when the combobox element shows its current value",
+  ).toHaveValue("");
+  await expect(
+    listbox,
+    "A combobox is said to be expanded when the associated popup is visible",
+  ).toBeVisible();
+  await button.click(); // toggle to be closed
+
+  await expect(
+    combobox,
+    "Authors MUST set aria-expanded to false when it is collapsed.",
+  ).toHaveAttribute("aria-expanded", "false");
+  await button.click(); // toggle to be expanded
+  await expect(
+    combobox,
+    "Authors MUST set aria-expanded to true when it is expanded.",
+  ).toHaveAttribute("aria-expanded", "true");
+  await button.click(); // toggle to be closed
+
+  await button.focus();
+  await expectToHaveFocus(button, "authors SHOULD ensure that the button is focusable");
+  await expect(
+    button,
+    "authors SHOULD ensure that the button is not included in the page Tab sequence",
+  ).toHaveAttribute("tabindex", "-1");
+  await expect(
+    combobox.getByRole("button"),
+    "authors SHOULD ensure that the button is not a descendant of the element with role combobox",
+  ).toHaveCount(0);
+
+  const firstElement = options.first();
+
+  // open and select first option
+  await combobox.focus();
+  await page.keyboard.press("ArrowDown");
+  await page.keyboard.press("ArrowDown");
+
+  const firstId = await (await firstElement.elementHandle())!.getAttribute("id");
+  expect(typeof firstId).toBe("string");
+  await expect(
+    combobox,
+    "When a descendant of the popup element is active, authors MAY set aria-activedescendant on the combobox to a value that refers to the active element within the popup.",
+  ).toHaveAttribute("aria-activedescendant", firstId as string);
+  await expectToHaveFocus(
+    combobox,
+    "When a descendant of the popup element is active, authors MAY ensure that the focus remains on the combobox element",
+  );
+};

package/src/composables/comboBox/TestDropdown.vue

@@ -0,0 +1,73 @@
+<script setup lang="ts">
+import { computed, ref } from "vue";
+import { createComboBox } from "./createComboBox";
+
+const elements = ["a", "b", "c", "d"];
+const isExpanded = ref(false);
+const activeKey = ref("");
+const selectedIndex = computed<number | undefined>(() => {
+  const index = elements.indexOf(activeKey.value);
+  return index !== -1 ? index : undefined;
+});
+
+const onFirst = () => (activeKey.value = elements[0]);
+const onLast = () => (activeKey.value = elements[elements.length - 1]);
+const onNext = () => {
+  if (selectedIndex.value === undefined) {
+    return onFirst();
+  }
+  activeKey.value = elements[selectedIndex.value + (1 % (elements.length - 1))];
+};
+const onPrevious = () => (activeKey.value = elements[(selectedIndex.value ?? 0) - 1]);
+const onSelect = (key: string) => (activeKey.value = key);
+const onToggle = () => (isExpanded.value = !isExpanded.value);
+
+const comboBox = createComboBox({
+  isExpanded,
+  onToggle,
+  onFirst,
+  onLast,
+  onNext,
+  onPrevious,
+  onSelect,
+  activeKey,
+});
+
+const {
+  elements: { input, label, listBox, button, option },
+} = comboBox;
+
+defineExpose({ comboBox });
+</script>
+<template>
+  <div>
+    <label v-bind="label">
+      some label:
+      <input
+        v-bind="input"
+        @keydown.arrow-down="isExpanded = true"
+        @keydown.esc="isExpanded = false"
+      />
+    </label>
+
+    <button v-bind="button">
+      <template v-if="isExpanded">⬆️</template>
+      <template v-else>⬇️</template>
+    </button>
+    <ul v-bind="listBox" :class="{ hidden: !isExpanded }" style="width: 400px">
+      <li
+        v-for="e in elements"
+        :key="e"
+        v-bind="option({ key: e, label: e, disabled: false })"
+        :style="{ 'background-color': e === activeKey ? 'red' : undefined }"
+      >
+        {{ e }}
+      </li>
+    </ul>
+  </div>
+</template>
+<style>
+.hidden {
+  display: none;
+}
+</style>

package/src/composables/comboBox/createComboBox.ts

@@ -0,0 +1,133 @@
+import { computed, ref, type Ref } from "vue";
+import { createId } from "../../utils/id";
+import { createBuilder, computeIterated } from "../../utils/builder";
+
+// TODO: https://w3c.github.io/aria/#aria-autocomplete
+// TODO: https://www.w3.org/WAI/ARIA/apg/patterns/combobox/
+// TODO: button as optional
+
+export const createComboBox = createBuilder(
+  ({
+    isExpanded,
+    activeKey,
+    onToggle,
+    onSelect,
+    onFirst,
+    onLast,
+    onNext,
+    onPrevious,
+  }: {
+    isExpanded: Ref<boolean>;
+    activeKey: Ref<string | undefined>;
+    onToggle: () => void;
+    onSelect: (key: string) => void;
+    onFirst: () => void;
+    onLast: () => void;
+    onNext: () => void;
+    onPrevious: () => void;
+  }) => {
+    const inputValue = ref("");
+    const inputValid = ref(true);
+    const controlsId = createId("comboBox-control");
+    const labelId = createId("comboBox-label");
+
+    const descendantKeyIdMap: Record<string, string | undefined> = {};
+
+    const getOptionId = (key: string) =>
+      descendantKeyIdMap[key] ?? (descendantKeyIdMap[key] = createId("comboBox-option"));
+
+    const handleInput = (event: Event) => {
+      const inputElement = event.target as HTMLInputElement;
+      inputValue.value = inputElement.value;
+      inputValid.value = inputElement.validity.valid;
+    };
+
+    const handleBlur = () => {
+      if (isExpanded.value) {
+        onToggle();
+      }
+    };
+
+    const handleKeydown = (event: KeyboardEvent) => {
+      if (!isExpanded.value) {
+        return;
+      }
+      switch (event.key) {
+        case "Escape":
+          onToggle();
+          break;
+        case "ArrowUp":
+          if (!activeKey.value) {
+            return onLast();
+          }
+          onPrevious();
+          break;
+        case "ArrowDown":
+          if (!activeKey.value) {
+            return onFirst();
+          }
+          onNext();
+          break;
+        case "Home":
+          onFirst();
+          break;
+        case "End":
+          onLast();
+          break;
+      }
+    };
+
+    return {
+      elements: {
+        /**
+         * The label element for the combobox input element.
+         */
+        label: {
+          id: labelId,
+        },
+        /**
+         * The listbox associated with the combobox.
+         */
+        listBox: computed(() => ({
+          role: "listbox",
+          id: controlsId,
+        })),
+        option: computeIterated<{ key: string; label: string; disabled: boolean }>(
+          ({ key, label, disabled }) => ({
+            role: "option",
+            id: getOptionId(key),
+            "aria-selected": activeKey.value === key,
+            "aria-label": label,
+            "aria-disabled": disabled,
+            onClick: () => onSelect(key),
+          }),
+        ),
+        /**
+         * An input that controls another element, that can dynamically pop-up to help the user set the value of the input.
+         * 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,
+          "aria-labelledby": labelId,
+          "aria-activedescendant": activeKey.value ? getOptionId(activeKey.value) : undefined,
+          onInput: handleInput,
+          onKeydown: handleKeydown,
+          onBlur: handleBlur,
+        })),
+        /**
+         * An optional button to control the visibility of the popup.
+         */
+        button: computed(() => ({
+          tabindex: "-1",
+          onClick: onToggle,
+        })),
+      },
+      state: {
+        inputValue,
+      },
+    };
+  },
+);

package/src/index.ts

@@ -1 +1 @@
-export * from "./composables/createComboBox";
+export * from "./composables/comboBox/createComboBox";

package/src/playwright.ts

@@ -0,0 +1 @@
+export { comboboxTesting } from "./composables/comboBox/TestDropdown.ct";

package/src/utils/builder.ts

@@ -0,0 +1,43 @@
+import { computed, type ComputedRef, type HtmlHTMLAttributes, type Ref } from "vue";
+
+export type IteratedHeadlessElementFunc<T extends Record<string, unknown>> = (
+  opts: T,
+) => HtmlHTMLAttributes;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type HeadlessElementAttributes = HtmlHTMLAttributes | IteratedHeadlessElementFunc<any>;
+
+export type HeadlessElements = Record<
+  string,
+  HeadlessElementAttributes | ComputedRef<HeadlessElementAttributes>
+>;
+
+export type HeadlessState = Record<string, Ref>;
+
+export type HeadlessComposable<Elements extends HeadlessElements, State extends HeadlessState> = {
+  elements: Elements;
+  state: State;
+};
+
+/**
+ * We use this identity function to ensure the correct typings of the headless composables
+ */
+export const createBuilder = <P, Elements extends HeadlessElements, State extends HeadlessState>(
+  builder: (props: P) => HeadlessComposable<Elements, State>,
+) => builder;
+
+/**
+ * Shorthand function for creating a typed IteratedHeadlessElementFunction
+ * @example
+ * ```ts
+ * {
+ *   option: computeIterated<{ key: string; label: string; disabled: boolean }>(
+ *     ({ key, label, disabled }) => ({
+ *       // Do something with the typed props
+ *     }),
+ * }
+ * ```
+ */
+export const computeIterated = <P extends Record<string, unknown>>(
+  iteratedFunc: IteratedHeadlessElementFunc<P>,
+) => computed(() => iteratedFunc);

package/src/utils/id.ts

@@ -0,0 +1,10 @@
+/**
+ * Returns a unique global id string
+ */
+// ⚠️ we make use of an IIFE to encapsulate the globalCounter so it can never accidentally be used somewhere else.
+const nextId = (() => {
+  let globalCounter = 0;
+  return () => globalCounter++;
+})();
+
+export const createId = (name: string) => `${name}-${nextId()}`;

package/src/composables/createComboBox.ts

@@ -1,6 +0,0 @@
-export const createComboBox = () => {
-  return {
-    elements: {},
-    state: {},
-  };
-};

package/tsconfig.json

@@ -1,109 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
-
-    /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-    /* Language and Environment */
-    "target": "ES2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
-    /* Modules */
-    "module": "ESNext" /* Specify what module code is generated. */,
-    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
-    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
-    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
-    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files. */
-    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
-    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
-
-    /* JavaScript Support */
-    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-
-    /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
-    "noEmit": true /* Disable emitting files from a compilation. */,
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
-    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-    /* Interop Constraints */
-    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
-    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
-    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-
-    /* Type Checking */
-    "strict": true /* Enable all strict type-checking options. */,
-    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
-    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
-    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
-    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
-    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
-    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
-    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
-    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
-    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-    /* Completeness */
-    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true /* Skip type checking all .d.ts files. */
-  }
-}