@sit-onyx/headless 1.0.0-beta.0 → 1.0.0-beta.10

package/src/composables/tooltip/createTooltip.ts

@@ -1,43 +1,26 @@
-import { computed, onBeforeMount, onBeforeUnmount, ref, unref, type MaybeRef } from "vue";
-import { createId } from "../..";
+import { computed, toRef, toValue, useId, type MaybeRefOrGetter, type Ref } from "vue";
 import { createBuilder } from "../../utils/builder";
-import { useOutsideClick } from "../outsideClick";
+import { useDismissible } from "../helpers/useDismissible";
 
 export type CreateTooltipOptions = {
-  open: MaybeRef<TooltipOpen>;
+  /**
+   * Number of milliseconds to use as debounce when showing/hiding the tooltip.
+   */
+  debounce: MaybeRefOrGetter<number>;
+  isVisible?: Ref<boolean>;
 };
 
-export type TooltipOpen =
-  | TooltipTrigger
-  | boolean
-  | {
-      type: "hover";
-      /**
-       * Number of milliseconds to use as debounce when showing/hiding the tooltip
-       */
-      debounce: number;
-    };
-
-export const TOOLTIP_TRIGGERS = ["hover", "click"] as const;
-export type TooltipTrigger = (typeof TOOLTIP_TRIGGERS)[number];
-
-export const createTooltip = createBuilder((options: CreateTooltipOptions) => {
-  const tooltipId = createId("tooltip");
-  const _isVisible = ref(false);
+/**
+ * Create a tooltip as described in https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/tooltip_role
+ * Its visibility is toggled on hover or focus.
+ * A tooltip MUST be used to describe the associated trigger element. E.g. The usage with the ⓘ would be incorrect.
+ * To provide contextual information use the `createToggletip`.
+ */
+export const createTooltip = createBuilder(({ debounce, isVisible }: CreateTooltipOptions) => {
+  const tooltipId = useId();
+  const _isVisible = toRef(isVisible ?? false);
   let timeout: ReturnType<typeof setTimeout> | undefined;
 
-  const debounce = computed(() => {
-    const open = unref(options.open);
-    if (typeof open !== "object") return 200;
-    return open.debounce;
-  });
-
-  const openType = computed(() => {
-    const open = unref(options.open);
-    if (typeof open !== "object") return open;
-    return open.type;
-  });
-
   /**
    * Debounced visible state that will only be toggled after a given timeout.
    */
@@ -47,79 +30,41 @@ export const createTooltip = createBuilder((options: CreateTooltipOptions) => {
       clearTimeout(timeout);
       timeout = setTimeout(() => {
         _isVisible.value = newValue;
-      }, debounce.value);
+      }, toValue(debounce));
     },
   });
 
-  /**
-   * Whether the tooltip should be currently visible.
-   * If openMode is set as boolean it will prefer it over the hover/click state.
-   */
-  const isVisible = computed(() => {
-    if (typeof openType.value === "boolean") return openType.value;
-    return debouncedVisible.value;
-  });
-
-  /**
-   * Toggles the tooltip if element is clicked.
-   */
-  const handleClick = () => {
-    _isVisible.value = !_isVisible.value;
+  const hoverEvents = {
+    onMouseover: () => (debouncedVisible.value = true),
+    onMouseout: () => (debouncedVisible.value = false),
+    onFocusin: () => (_isVisible.value = true),
+    onFocusout: () => (_isVisible.value = false),
   };
 
-  const hoverEvents = computed(() => {
-    if (openType.value !== "hover") return;
-    return {
-      onMouseover: () => (debouncedVisible.value = true),
-      onMouseout: () => (debouncedVisible.value = false),
-      onFocusin: () => (_isVisible.value = true),
-      onFocusout: () => (_isVisible.value = false),
-    };
-  });
-
-  /**
-   * Closes the tooltip if Escape is pressed.
-   */
-  const handleDocumentKeydown = (event: KeyboardEvent) => {
-    if (event.key !== "Escape") return;
-    _isVisible.value = false;
-  };
-
-  // close tooltip on outside click
-  useOutsideClick({
-    queryComponent: () => document.getElementById(tooltipId)?.parentElement,
-    onOutsideClick: () => (_isVisible.value = false),
-    disabled: computed(() => openType.value !== "click"),
-  });
-
-  // add global document event listeners only on/before mounted to also work in server side rendering
-  onBeforeMount(() => {
-    document.addEventListener("keydown", handleDocumentKeydown);
-  });
-
-  /**
-   * Clean up global event listeners to prevent dangling events.
-   */
-  onBeforeUnmount(() => {
-    document.removeEventListener("keydown", handleDocumentKeydown);
-  });
+  useDismissible({ isExpanded: _isVisible });
 
   return {
     elements: {
-      trigger: computed(() => ({
+      /**
+       * The element which controls the tooltip visibility on hover.
+       */
+      trigger: {
         "aria-describedby": tooltipId,
-        onClick: openType.value === "click" ? handleClick : undefined,
-        ...hoverEvents.value,
-      })),
-      tooltip: computed(() => ({
+        ...hoverEvents,
+      },
+      /**
+       * The element describing the tooltip.
+       * Only simple, textual and non-focusable content is allowed.
+       */
+      tooltip: {
         role: "tooltip",
         id: tooltipId,
         tabindex: "-1",
-        ...hoverEvents.value,
-      })),
+        ...hoverEvents,
+      },
     },
     state: {
-      isVisible,
+      isVisible: _isVisible,
     },
   };
 });

package/src/index.ts

@@ -1,6 +1,11 @@
 export * from "./composables/comboBox/createComboBox";
+export * from "./composables/helpers/useGlobalListener";
 export * from "./composables/listbox/createListbox";
 export * from "./composables/menuButton/createMenuButton";
+export * from "./composables/navigationMenu/createMenu";
+export * from "./composables/tabs/createTabs";
+export * from "./composables/tooltip/createToggletip";
 export * from "./composables/tooltip/createTooltip";
-export { createId } from "./utils/id";
+export * from "./utils/builder";
 export { isPrintableCharacter, wasKeyPressed } from "./utils/keyboard";
+export { debounce } from "./utils/timer";

package/src/playwright.ts

@@ -1,3 +1,5 @@
-export * from "./composables/comboBox/createComboBox.ct";
-export * from "./composables/listbox/createListbox.ct";
-export * from "./composables/menuButton/createMenuButton.ct";
+export * from "./composables/comboBox/createComboBox.testing";
+export * from "./composables/listbox/createListbox.testing";
+export * from "./composables/menuButton/createMenuButton.testing";
+export * from "./composables/navigationMenu/createMenu.testing";
+export * from "./composables/tabs/createTabs.testing";

package/src/utils/builder.ts

@@ -1,17 +1,38 @@
-import type { ComputedRef, HtmlHTMLAttributes, Ref } from "vue";
+import {
+  computed,
+  shallowRef,
+  type ComponentPublicInstance,
+  type HTMLAttributes,
+  type MaybeRef,
+  type Ref,
+  type WritableComputedOptions,
+  type WritableComputedRef,
+} from "vue";
 import type { IfDefined } from "./types";
 
-export type IteratedHeadlessElementFunc<T extends Record<string, unknown>> = (
-  opts: T,
-) => HtmlHTMLAttributes;
+/**
+ * Properties as they can be used by `v-bind` on an HTML element.
+ * This includes generic html attributes and the vue reserved `ref` property.
+ * `ref` is restricted to be a `HeadlessElRef` which only can by created through `createElRef`.
+ */
+export type VBindAttributes<
+  A extends HTMLAttributes = HTMLAttributes,
+  E extends Element = Element,
+> = A & {
+  ref?: VueTemplateRef<E>;
+};
+
+export type IteratedHeadlessElementFunc<
+  A extends HTMLAttributes,
+  T extends Record<string, unknown>,
+> = (opts: T) => VBindAttributes<A>;
 
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type HeadlessElementAttributes = HtmlHTMLAttributes | IteratedHeadlessElementFunc<any>;
+export type HeadlessElementAttributes<A extends HTMLAttributes> =
+  | VBindAttributes<A>
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  | IteratedHeadlessElementFunc<A, any>;
 
-export type HeadlessElements = Record<
-  string,
-  HeadlessElementAttributes | ComputedRef<HeadlessElementAttributes>
->;
+export type HeadlessElements = Record<string, MaybeRef<HeadlessElementAttributes<HTMLAttributes>>>;
 
 export type HeadlessState = Record<string, Ref>;
 
@@ -26,12 +47,89 @@ export type HeadlessComposable<
 
 /**
  * We use this identity function to ensure the correct typings of the headless composables
+ * @example
+ * ```ts
+ * export const createTooltip = createBuilder(({ initialVisible }: CreateTooltipOptions) => {
+ *   const tooltipId = useId();
+ *   const isVisible = ref(initialVisible);
+ *
+ *   const hoverEvents = {
+ *     onMouseover: () => (isVisible.value = true),
+ *     onMouseout: () => (isVisible.value = false),
+ *     onFocusin: () => (isVisible.value = true),
+ *     onFocusout: () => (isVisible.value = false),
+ *   };
+ *
+ *   return {
+ *     elements: {
+ *       trigger: {
+ *         "aria-describedby": tooltipId,
+ *         ...hoverEvents,
+ *       },
+ *       tooltip: {
+ *         role: "tooltip",
+ *         id: tooltipId,
+ *         tabindex: "-1",
+ *         ...hoverEvents,
+ *       },
+ *     },
+ *     state: {
+ *       isVisible,
+ *     },
+ *   };
+ * });
+ *
+ * ```
  */
 export const createBuilder = <
-  P,
-  Elements extends HeadlessElements,
+  Args extends unknown[] = unknown[],
+  Elements extends HeadlessElements = HeadlessElements,
   State extends HeadlessState | undefined = undefined,
   Internals extends object | undefined = undefined,
 >(
-  builder: (props: P) => HeadlessComposable<Elements, State, Internals>,
+  builder: (...args: Args) => HeadlessComposable<Elements, State, Internals>,
 ) => builder;
+
+type VueTemplateRefElement<E extends Element> = E | (ComponentPublicInstance & { $el: E }) | null;
+type VueTemplateRef<E extends Element> = Ref<VueTemplateRefElement<E>>;
+
+declare const HeadlessElRefSymbol: unique symbol;
+type HeadlessElRef<E extends Element> = WritableComputedRef<E> & {
+  /**
+   * type differentiator
+   * ensures that only `createElRef` can be used for headless element ref bindings
+   */
+  [HeadlessElRefSymbol]: true;
+};
+
+/**
+ * Creates a special writeable computed that references a DOM Element.
+ * Vue Component references will be unwrapped.
+ * @example
+ * ```ts
+ * createBuilder() => {
+ *  const buttonRef = createElRef<HtmlButtonElement>();
+ *  return {
+ *    elements: {
+ *      button: {
+ *        ref: buttonRef,
+ *      },
+ *    }
+ *  };
+ * });
+ * ```
+ */
+export function createElRef<E extends Element>(): HeadlessElRef<E>;
+export function createElRef<
+  E extends Element,
+  V extends VueTemplateRefElement<E> = VueTemplateRefElement<E>,
+>() {
+  const elementRef = shallowRef<E>();
+
+  return computed({
+    set: (element: V) => {
+      elementRef.value = element != null && "$el" in element ? element.$el : (element as E);
+    },
+    get: () => elementRef.value,
+  } as WritableComputedOptions<E>);
+}

package/src/utils/math.spec.ts

@@ -0,0 +1,14 @@
+import { describe, expect, test } from "vitest";
+import { MathUtils } from "./math";
+
+describe("MathUtils.clamp", () => {
+  test.each([
+    { number: 1, min: 1, max: 2, result: 1 },
+    { number: 1, min: 2, max: 2, result: 2 },
+    { number: 1, min: 0, max: 0, result: 0 },
+    { number: 1, min: 1, max: 1, result: 1 },
+  ])(
+    "should return $result for key number:$number min:$min max:$max",
+    ({ number, min, max, result }) => expect(MathUtils.clamp(number, min, max)).toBe(result),
+  );
+});

package/src/utils/math.ts

@@ -0,0 +1,6 @@
+export const MathUtils = {
+  /**
+   * Ensures that a given `number` is or is between a given `min` and `max`.
+   */
+  clamp: (number: number, min: number, max: number) => Math.max(Math.min(number, max), min),
+};

package/src/utils/types.ts

@@ -1,3 +1,5 @@
+import type { ComputedRef, MaybeRefOrGetter } from "vue";
+
 /**
  * Adds the entry with the key `Key` and the value of type `TValue` to a record when it is defined.
  * Then the entry is either undefined or exists without being optional.
@@ -21,3 +23,8 @@ export type IfDefined<Key extends string, TValue> =
 export type IsArray<TValue, TMultiple extends boolean = false> = TMultiple extends true
   ? TValue[]
   : TValue;
+
+/**
+ * Type for any kind of ref source. Preferably used in combination with vue's `toValue` method
+ */
+export type MaybeReactiveSource<T> = MaybeRefOrGetter<T> | ComputedRef<T>;

package/src/utils/vitest.ts

@@ -0,0 +1,36 @@
+import { vi } from "vitest";
+
+type Callback = () => void | (() => Promise<void>);
+
+/**
+ * Mocks the following vue lifecycle functions:
+ * - onBeforeMount
+ * - onMounted
+ * - onBeforeUnmount
+ * - onUnmounted
+ *
+ * `onBeforeMount` and `onMounted` callbacks are executed immediately.
+ * `onBeforeUnmount` and `onUnmounted` are executed when the returned callback is run.
+ * @returns a callback to trigger the run of `onBeforeUnmount` and `onUnmounted`
+ */
+export const mockVueLifecycle = () => {
+  const { callbacks } = vi.hoisted(() => ({
+    callbacks: {
+      onBeforeUnmountedCb: null as Callback | null,
+      onUnmountedCb: null as Callback | null,
+    },
+  }));
+
+  vi.mock("vue", async (original) => ({
+    ...((await original()) as typeof import("vue")),
+    onBeforeMount: vi.fn((cb: Callback) => cb()),
+    onMounted: vi.fn((cb: Callback) => cb()),
+    onBeforeUnmount: vi.fn((cb: Callback) => (callbacks.onBeforeUnmountedCb = cb)),
+    onUnmounted: vi.fn((cb: Callback) => (callbacks.onUnmountedCb = cb)),
+  }));
+
+  return async () => {
+    await callbacks.onBeforeUnmountedCb?.();
+    await callbacks.onUnmountedCb?.();
+  };
+};

package/src/composables/outsideClick.ts

@@ -1,52 +0,0 @@
-import { onBeforeMount, onBeforeUnmount, watchEffect, type Ref } from "vue";
-
-export type UseOutsideClickOptions = {
-  /**
-   * Function that returns the HTML element of the component where outside clicks should be listened to.
-   */
-  queryComponent: () => ReturnType<typeof document.querySelector> | undefined;
-  /**
-   * Callback when an outside click occurred.
-   */
-  onOutsideClick: () => void;
-  /**
-   * If `true`, event listeners will be removed and no outside clicks will be captured.
-   */
-  disabled?: Ref<boolean>;
-};
-
-/**
- * Composable for listening to click events that occur outside of a component.
- * Useful to e.g. close flyouts or tooltips.
- */
-export const useOutsideClick = (options: UseOutsideClickOptions) => {
-  /**
-   * Document click handle that closes then tooltip when clicked outside.
-   * Should only be called when trigger is "click".
-   */
-  const handleDocumentClick = (event: MouseEvent) => {
-    const component = options.queryComponent();
-    if (!component || !(event.target instanceof Node)) return;
-
-    const isOutsideClick = !component.contains(event.target);
-    if (isOutsideClick) options.onOutsideClick();
-  };
-
-  // add global document event listeners only on/before mounted to also work in server side rendering
-  onBeforeMount(() => {
-    watchEffect(() => {
-      if (options.disabled?.value) {
-        document.removeEventListener("click", handleDocumentClick);
-      } else {
-        document.addEventListener("click", handleDocumentClick);
-      }
-    });
-  });
-
-  /**
-   * Clean up global event listeners to prevent dangling events.
-   */
-  onBeforeUnmount(() => {
-    document.removeEventListener("click", handleDocumentClick);
-  });
-};

package/src/utils/id.ts

@@ -1,14 +0,0 @@
-/**
- * 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 = 1;
-  return () => globalCounter++;
-})();
-
-/**
- * Creates a globally unique string using a counter.
- * The given name is the prefix.
- */
-export const createId = (name: string) => `${name}-${nextId()}`;