@uniflowed/ui 0.0.0-alpha.9 → 0.1.0

package/internal/anchor.js

@@ -108,6 +108,19 @@ import { directionOf } from "./roving-focus.js";
  */
 export type Side = "top" | "right" | "bottom" | "left";
 
+/**
+ * A side a caller may ask for, which is the four above plus the two that mean
+ * "the way the reader reads".
+ *
+ * The WAI-ARIA menu pattern puts a submenu on the inline end - to the right of a
+ * left-to-right menu and to the left of a right-to-left one - and `menu.js`
+ * already spells the *keys* that way, so a physical-only `side` would have left
+ * one half of that pattern mirrored and the other half not. `Placement` and
+ * `placeOverlay` stay physical: a logical side is resolved once, against the
+ * trigger's own direction, before any arithmetic sees it.
+ */
+export type LogicalSide = Side | "inline-start" | "inline-end";
+
 /**
  * Where the overlay sits along the trigger's other axis.
  *
@@ -170,10 +183,29 @@ export type Anchored = {|
 /** What `useAnchor` is told, on top of the geometry `placeOverlay` needs. */
 export type AnchorRequest = {|
   readonly anchorRef: { current: HTMLElement | null },
+  /**
+   * A box to place against instead of the anchor element's own.
+   *
+   * A context menu opens *at a point* rather than against an element: the
+   * pointer coordinates the reader right-clicked at, which is a zero-sized
+   * rectangle no element in the document has. The element is still needed —
+   * it is what the writing direction is read from, what a `ResizeObserver`
+   * watches, and what focus returns to — so this replaces the *measurement*
+   * and nothing else.
+   *
+   * `null` (and absent) means "measure the element", which is every other
+   * overlay in this package.
+   *
+   * It has to be stable between renders for the same position, because it is
+   * one of the things the placement effect re-runs for; a fresh object each
+   * render would re-measure on every render of the page around it.
+   */
+  readonly anchorRect?: Rect | null,
   readonly overlayRef: { current: HTMLElement | null },
   /** Nothing is measured while it is closed: there is nothing to measure. */
   readonly open: boolean,
-  readonly side: Side,
+  /** Resolved against the trigger's writing direction; see `LogicalSide`. */
+  readonly side: LogicalSide,
   readonly align: Align,
   readonly sideOffset: number,
   readonly alignOffset: number,
@@ -189,6 +221,28 @@ const OPPOSITE: { readonly [Side]: Side } = {
   right: "left",
 };
 
+/**
+ * The side on the screen that `side` names for a reader reading `direction`.
+ *
+ * The four physical ones pass through unchanged, because a design that puts a
+ * popover to the right of a toolbar means the right of the toolbar in Arabic
+ * too; `Side`'s own documentation says why that is the useful default and why
+ * alignment is the axis that mirrors.
+ */
+export function physicalSide(side: LogicalSide, direction: Direction): Side {
+  // Written out rather than left to a wildcard, so that a sixth side added to
+  // `LogicalSide` one day is a checker error here instead of a value that falls
+  // through unresolved.
+  return match (side) {
+    "inline-start" => direction === "rtl" ? "right" : "left",
+    "inline-end" => direction === "rtl" ? "left" : "right",
+    "top" => "top",
+    "right" => "right",
+    "bottom" => "bottom",
+    "left" => "left",
+  };
+}
+
 /** Whether a side stacks the overlay above the trigger or beside it. */
 function isVertical(side: Side): boolean {
   return side === "top" || side === "bottom";
@@ -388,6 +442,7 @@ export hook useAnchor(request: AnchorRequest): Anchored {
   const {
     align,
     alignOffset,
+    anchorRect,
     anchorRef,
     avoidCollisions,
     collisionPadding,
@@ -396,7 +451,15 @@ export hook useAnchor(request: AnchorRequest): Anchored {
     side,
     sideOffset,
   } = request;
-  const [settled, setSettled] = useState<Anchored>({ align, side });
+  // Absent and `null` are one answer here — "measure the element" — so the two
+  // spellings become one value before anything depends on it.
+  const virtual = anchorRect ?? null;
+  // The left-to-right reading of a logical side, which is what `Anchored`
+  // reports until something has been measured. In a right-to-left page a
+  // submenu's `inline-end` is the *left*, and the first `reflow` says so - one
+  // commit later, exactly as a flip does, and for the same reason: the direction
+  // is a fact about the document, and a render may not read one.
+  const [settled, setSettled] = useState<Anchored>({ align, side: physicalSide(side, "ltr") });
 
   const reflow = useStableCallback(() => {
     const anchor = anchorRef.current;
@@ -405,7 +468,7 @@ export hook useAnchor(request: AnchorRequest): Anchored {
     if (anchor == null || overlay == null || view == null) {
       return;
     }
-    const box = rectOf(anchor);
+    const box = virtual ?? rectOf(anchor);
     const placement = placeOverlay({
       align,
       alignOffset,
@@ -414,7 +477,7 @@ export hook useAnchor(request: AnchorRequest): Anchored {
       collisionPadding,
       direction: directionOf(anchor),
       overlay: rectOf(overlay),
-      side,
+      side: physicalSide(side, directionOf(anchor)),
       sideOffset,
       // The viewport of a fixed element, which is the whole of it: a fixed box
       // is positioned against the viewport rather than against whatever is
@@ -443,8 +506,9 @@ export hook useAnchor(request: AnchorRequest): Anchored {
       // drawn from `data-side` pointing the wrong way, after a reopen that
       // follows a flip.
       if (!open) {
+        const asked = physicalSide(side, anchor == null ? "ltr" : directionOf(anchor));
         setSettled((current) =>
-          current.side === side && current.align === align ? current : { align, side },
+          current.side === asked && current.align === align ? current : { align, side: asked },
         );
       }
       return;
@@ -482,6 +546,7 @@ export hook useAnchor(request: AnchorRequest): Anchored {
   }, [
     align,
     alignOffset,
+    anchorRect,
     anchorRef,
     avoidCollisions,
     collisionPadding,
@@ -496,5 +561,5 @@ export hook useAnchor(request: AnchorRequest): Anchored {
   // first commit — and the server's markup, which measures nothing at all —
   // says the requested side rather than the last one some other opening
   // happened to settle on.
-  return open ? settled : { align, side };
+  return open ? settled : { align, side: physicalSide(side, "ltr") };
 }

package/internal/collection.js

@@ -0,0 +1,395 @@
+// @flow
+"use client";
+
+import * as React from "@uniflowed/react";
+import { useId, useRef, useState } from "@uniflowed/react";
+import { useStableCallback } from "@uniflowed/hooks/lifecycle";
+import { useDragAndDrop } from "../drag-drop.js";
+import { useControlled } from "./controlled-state.js";
+import { composeHandlers, composeRefs, withProps } from "./merge-props.js";
+import type { RenderProp, Rest } from "./merge-props.js";
+import { directionOf } from "./roving-focus.js";
+import { startsWithLocale, useLocale } from "../i18n-provider.js";
+
+export type CollectionItem = {
+  readonly key: string,
+  readonly textValue: string,
+  readonly disabled?: boolean,
+  readonly children?: $ReadOnlyArray<CollectionItem>,
+};
+export type CollectionItemState = {
+  readonly selected: boolean,
+  readonly active: boolean,
+  readonly disabled: boolean,
+  readonly level: number,
+};
+type Entry = {
+  item: CollectionItem,
+  level: number,
+  parent: string | null,
+  position: number,
+  count: number,
+};
+type Kind = "listbox" | "grid" | "tree" | "tags";
+
+function entries(
+  items: $ReadOnlyArray<CollectionItem>,
+  expanded: $ReadOnlyArray<string>,
+  tree: boolean,
+): Array<Entry> {
+  const result = [];
+  const seen = new Set<string>();
+  const visit = (
+    siblings: $ReadOnlyArray<CollectionItem>,
+    level: number,
+    parent: string | null,
+  ): void => {
+    siblings.forEach((item, index) => {
+      if (seen.has(item.key)) throw new Error(`Duplicate collection key: ${item.key}`);
+      seen.add(item.key);
+      result.push({ item, level, parent, position: index + 1, count: siblings.length });
+      const children = item.children;
+      if (tree && children != null && expanded.includes(item.key))
+        visit(children, level + 1, item.key);
+    });
+  };
+  visit(items, 1, null);
+  return result;
+}
+
+/** Data owns order and identity. Only visible tree descendants and virtual rows enter the DOM. */
+export component CollectionRoot(kind: Kind, options: CollectionProps) {
+  const {
+    items,
+    children,
+    selectionMode: requestedSelectionMode = "single",
+    selectedKeys,
+    defaultSelectedKeys = [],
+    onSelectionChange,
+    disabledKeys = [],
+    expandedKeys,
+    defaultExpandedKeys = [],
+    onExpandedChange,
+    onRemove,
+    onReorder,
+    loading = false,
+    onLoadMore,
+    virtualized = false,
+    height = 300,
+    rowHeight = 30,
+    render,
+    ...rest
+  } = options;
+  const selectionMode = kind === "tags" ? "none" : requestedSelectionMode;
+  if (height <= 0 || rowHeight <= 0 || !Number.isFinite(height) || !Number.isFinite(rowHeight))
+    throw new RangeError("Collection dimensions must be positive finite numbers");
+  const { locale } = useLocale();
+  const id = useId();
+  const root = useRef<HTMLElement | null>(null);
+  const anchor = useRef<string | null>(null);
+  const buffer = useRef({ text: "", time: 0 });
+  const [selected, setSelected] = useControlled(
+    selectedKeys,
+    defaultSelectedKeys,
+    onSelectionChange,
+  );
+  const [expanded, setExpanded] = useControlled(
+    expandedKeys,
+    defaultExpandedKeys,
+    onExpandedChange,
+  );
+  const [active, setActive] = useState<string | null>(null);
+  const [scrollTop, setScrollTop] = useState(0);
+  const [announcement, announce] = useState("");
+  const drag = useDragAndDrop({
+    disabled: onReorder == null,
+    onDrop: ({ keys, target }) => {
+      const moving = keys[0];
+      if (
+        [moving, target].some(
+          (key) => disabledKeys.includes(key) || items.find((item) => item.key === key)?.disabled,
+        )
+      )
+        return;
+      if (
+        moving === target ||
+        !items.some((item) => item.key === moving) ||
+        !items.some((item) => item.key === target)
+      )
+        return;
+      const ordered = items.filter((item) => item.key !== moving).map((item) => item.key);
+      ordered.splice(ordered.indexOf(target), 0, moving);
+      onReorder?.(ordered);
+    },
+  });
+  const rows = entries(items, expanded, kind === "tree");
+  const disabled = (item: CollectionItem) =>
+    item.disabled === true || disabledKeys.includes(item.key);
+  const enabled = rows.filter((row) => !disabled(row.item));
+  const focused =
+    enabled.find((row) => row.item.key === active) ??
+    enabled.find((row) => selected.includes(row.item.key)) ??
+    enabled[0];
+  const activeKey = focused?.item.key;
+  const choose = (key: string, range: boolean, toggle: boolean) => {
+    const item = rows.find((row) => row.item.key === key)?.item;
+    if (item == null || disabled(item) || selectionMode === "none") return;
+    let next;
+    if (selectionMode === "single") next = [key];
+    else if (range && anchor.current != null) {
+      const from = enabled.findIndex((row) => row.item.key === anchor.current);
+      const to = enabled.findIndex((row) => row.item.key === key);
+      next = enabled
+        .slice(Math.min(Math.max(from, 0), to), Math.max(from, to) + 1)
+        .map((row) => row.item.key);
+    } else {
+      next = toggle
+        ? selected.includes(key)
+          ? selected.filter((each) => each !== key)
+          : [...selected, key]
+        : [key];
+      anchor.current = key;
+    }
+    setSelected(next);
+    announce(`${next.length} selected`);
+  };
+  const land = (row: Entry, shift: boolean) => {
+    setActive(row.item.key);
+    const container = root.current;
+    if (virtualized && container != null) {
+      const top = rows.indexOf(row) * rowHeight;
+      if (top < container.scrollTop || top + rowHeight > container.scrollTop + height) {
+        container.scrollTop = top;
+        setScrollTop(top);
+      }
+    }
+    if (shift) choose(row.item.key, true, false);
+  };
+  const remove = (key: string) => {
+    const at = enabled.findIndex((row) => row.item.key === key);
+    if (at < 0 || onRemove == null) return;
+    onRemove(key);
+    setActive(enabled[at + 1]?.item.key ?? enabled[at - 1]?.item.key ?? null);
+    announce(`Removed ${enabled[at].item.textValue}`);
+  };
+  const keydown = useStableCallback((event: $FlowFixMe) => {
+    if (
+      event.target !== event.currentTarget &&
+      event.target.closest("button,input,textarea,select")
+    )
+      return;
+    if (drag.dragging && event.key === "Escape") {
+      event.preventDefault();
+      drag.cancel();
+      return;
+    }
+    if (drag.dragging && event.key === "Enter" && activeKey != null) {
+      event.preventDefault();
+      drag.drop(activeKey, undefined, focused?.item.textValue);
+      return;
+    }
+    if (
+      onReorder != null &&
+      event.key === " " &&
+      (event.ctrlKey || event.metaKey) &&
+      focused != null
+    ) {
+      event.preventDefault();
+      drag.start(focused.item.key, focused.item.textValue);
+      return;
+    }
+    const at = enabled.findIndex((row) => row.item.key === activeKey);
+    let next = null;
+    if (event.key === "ArrowDown") next = enabled[Math.min(at + 1, enabled.length - 1)];
+    else if (event.key === "ArrowUp") next = enabled[Math.max(at - 1, 0)];
+    else if (event.key === "Home") next = enabled[0];
+    else if (event.key === "End") {
+      next = enabled[enabled.length - 1];
+      if (!loading) onLoadMore?.();
+    } else if (
+      kind === "tree" &&
+      focused != null &&
+      ["ArrowLeft", "ArrowRight"].includes(event.key)
+    ) {
+      const open =
+        event.key === (directionOf(event.currentTarget) === "rtl" ? "ArrowLeft" : "ArrowRight");
+      const key = focused.item.key;
+      if (open && focused.item.children?.length) {
+        if (!expanded.includes(key)) setExpanded([...expanded, key]);
+        else next = enabled[at + 1];
+      } else if (!open && expanded.includes(key))
+        setExpanded(expanded.filter((each) => each !== key));
+      else if (!open) next = enabled.find((row) => row.item.key === focused.parent);
+    } else if (
+      (event.ctrlKey || event.metaKey) &&
+      event.key === "a" &&
+      selectionMode === "multiple"
+    ) {
+      setSelected(enabled.map((row) => row.item.key));
+      announce(`${enabled.length} selected`);
+    } else if ((event.key === " " || event.key === "Enter") && activeKey != null)
+      choose(activeKey, event.shiftKey, true);
+    else if (
+      (event.key === "Delete" || event.key === "Backspace") &&
+      kind === "tags" &&
+      activeKey != null
+    )
+      remove(activeKey);
+    else if (event.key.length === 1 && !event.ctrlKey && !event.metaKey && !event.altKey) {
+      const time = Date.now();
+      const text = time - buffer.current.time > 500 ? event.key : buffer.current.text + event.key;
+      buffer.current = { text, time };
+      const repeated = Array.from(text).every((char) => char === event.key);
+      const query = repeated ? event.key : text;
+      const start = repeated || text.length === 1 ? at + 1 : Math.max(at, 0);
+      for (let offset = 0; offset < enabled.length; offset += 1) {
+        const candidate = enabled[(start + offset) % enabled.length];
+        if (startsWithLocale(candidate.item.textValue, query, locale)) {
+          next = candidate;
+          break;
+        }
+      }
+    } else return;
+    event.preventDefault();
+    if (next != null) land(next, event.shiftKey);
+  });
+  const start = virtualized ? Math.max(0, Math.floor(scrollTop / rowHeight) - 2) : 0;
+  const end = virtualized
+    ? Math.min(rows.length, start + Math.ceil(height / rowHeight) + 4)
+    : rows.length;
+  // aria-activedescendant must always name a mounted row, even after a pointer scroll.
+  const indices = new Set(rows.slice(start, end).map((_, index) => start + index));
+  const activeIndex = rows.findIndex((row) => row.item.key === activeKey);
+  if (activeIndex >= 0) indices.add(activeIndex);
+  const rowNodes = Array.from(indices)
+    .sort((a, b) => a - b)
+    .map((index) => {
+      const row = rows[index];
+      const { item } = row;
+      const chosen = selected.includes(item.key);
+      const grid = kind === "grid" || kind === "tags";
+      const content =
+        children?.(item, {
+          selected: chosen,
+          active: activeKey === item.key,
+          disabled: disabled(item),
+          level: row.level,
+        }) ?? item.textValue;
+      const props = {
+        ...drag.getDragProps(item.key, item.textValue),
+        ...drag.getDropProps(item.key, item.textValue),
+        onKeyDown: undefined,
+        draggable: onReorder != null && !disabled(item),
+        id: `${id}-${index}`,
+        role: grid ? "row" : kind === "tree" ? "treeitem" : "option",
+        "aria-selected": selectionMode === "none" ? undefined : chosen,
+        "aria-disabled": disabled(item) || undefined,
+        "aria-expanded":
+          kind === "tree" && item.children?.length ? expanded.includes(item.key) : undefined,
+        "aria-level": kind === "tree" ? row.level : undefined,
+        "aria-posinset": grid ? undefined : kind === "tree" ? row.position : index + 1,
+        "aria-setsize": grid ? undefined : kind === "tree" ? row.count : rows.length,
+        "aria-rowindex": grid ? index + 1 : undefined,
+        "data-key": item.key,
+        "data-active": activeKey === item.key || undefined,
+        style: virtualized
+          ? { position: "absolute", top: index * rowHeight, height: rowHeight, width: "100%" }
+          : undefined,
+        onClick: (event: $FlowFixMe) => {
+          if (disabled(item)) return;
+          root.current?.focus();
+          setActive(item.key);
+          choose(item.key, event.shiftKey, selectionMode === "multiple");
+        },
+      };
+      return (
+        <div key={item.key} {...props}>
+          {grid ? (
+            <div role="gridcell">
+              {content}
+              {kind === "tags" && onRemove != null ? (
+                <button
+                  type="button"
+                  tabIndex={-1}
+                  disabled={disabled(item)}
+                  aria-label={`Remove ${item.textValue}`}
+                  onClick={(event) => {
+                    event.stopPropagation();
+                    root.current?.focus();
+                    remove(item.key);
+                  }}
+                >
+                  ×
+                </button>
+              ) : null}
+            </div>
+          ) : (
+            content
+          )}
+        </div>
+      );
+    });
+  const setRef = useStableCallback((element: HTMLElement | null) => {
+    root.current = element;
+  });
+  const props = withProps(rest, {
+    ref: composeRefs(rest.ref, setRef),
+    role: kind === "tags" ? "grid" : kind,
+    tabIndex: 0,
+    "aria-activedescendant": activeIndex < 0 ? undefined : `${id}-${activeIndex}`,
+    "aria-multiselectable": selectionMode === "multiple" || undefined,
+    "aria-busy": loading || undefined,
+    "aria-rowcount": kind === "grid" || kind === "tags" ? rows.length : undefined,
+    onKeyDown: composeHandlers(rest.onKeyDown, keydown),
+    onScroll: composeHandlers(rest.onScroll, (event: $FlowFixMe) => {
+      if (virtualized) setScrollTop(event.currentTarget.scrollTop);
+      if (
+        !loading &&
+        event.currentTarget.scrollTop + event.currentTarget.clientHeight >=
+          event.currentTarget.scrollHeight
+      )
+        onLoadMore?.();
+    }),
+    style: virtualized
+      ? { ...(rest.style as $FlowFixMe), height, overflow: "auto", position: "relative" }
+      : rest.style,
+    children: virtualized ? (
+      <div role="presentation" style={{ height: rows.length * rowHeight, position: "relative" }}>
+        {rowNodes}
+      </div>
+    ) : (
+      rowNodes
+    ),
+  });
+  return (
+    <>
+      {render != null ? render(props) : <div {...props} />}
+      <span role="status" aria-live="polite">
+        {drag.announcement || announcement}
+      </span>
+    </>
+  );
+}
+
+export type CollectionProps = {
+  items: $ReadOnlyArray<CollectionItem>,
+  children?: (item: CollectionItem, state: CollectionItemState) => React.Node,
+  selectionMode?: "single" | "multiple" | "none",
+  selectedKeys?: $ReadOnlyArray<string>,
+  defaultSelectedKeys?: $ReadOnlyArray<string>,
+  onSelectionChange?: (keys: $ReadOnlyArray<string>) => void,
+  disabledKeys?: $ReadOnlyArray<string>,
+  expandedKeys?: $ReadOnlyArray<string>,
+  defaultExpandedKeys?: $ReadOnlyArray<string>,
+  onExpandedChange?: (keys: $ReadOnlyArray<string>) => void,
+  onRemove?: (key: string) => void,
+  onReorder?: (keys: $ReadOnlyArray<string>) => void,
+  loading?: boolean,
+  onLoadMore?: () => void,
+  virtualized?: boolean,
+  height?: number,
+  rowHeight?: number,
+  render?: RenderProp,
+  readonly key?: empty,
+  readonly [string]: mixed,
+};