stimeo-ui 0.17.0 → 0.18.1

package/dist/controllers/context_menu_controller.d.ts

@@ -6,7 +6,8 @@ import { Controller } from '@hotwired/stimulus';
  * Markup contract (identifier: `stimeo--context-menu`):
  *   <div data-controller="stimeo--context-menu">
  *     <div data-stimeo--context-menu-target="region" tabindex="0"
- *          aria-haspopup="menu" aria-controls="ctx"
+ *          role="group" aria-label="Files"
+ *          aria-keyshortcuts="Shift+F10" aria-controls="ctx"
  *          data-action="contextmenu->stimeo--context-menu#open
  *                       keydown->stimeo--context-menu#onRegionKeydown">…</div>
  *     <ul id="ctx" role="menu" data-stimeo--context-menu-target="menu" hidden>
@@ -32,12 +33,25 @@ import { Controller } from '@hotwired/stimulus';
  * required). Viewport-edge flip/shift is delegated to the opt-in
  * `stimeo-ui/positioning` module, which this controller never imports.
  *
+ * The region's role and name are the author's: a `role="group"` with
+ * `aria-label`, or an element that has a role of its own (a table row, a list
+ * item, a button), chosen to match what the region holds. The controller writes
+ * no role. The author also points `aria-controls` at the menu and advertises the
+ * opening key with `aria-keyshortcuts="Shift+F10"`. The region carries no
+ * `aria-haspopup`, whatever its role. On a role that supports it, such as a
+ * button, the attribute conveys what ARIA 1.2's note says its visual
+ * counterparts, such as a downward-pointing triangle, signal: that activating
+ * the control (a click, `Enter`) displays a popup. This menu opens on a
+ * `contextmenu` event or the `Shift+F10` / `ContextMenu` key instead, so the
+ * attribute would point to the wrong gesture. On a role that does not, such as
+ * `generic`, `group`, `row` or `listitem`, it would be a global use of the
+ * attribute, which ARIA 1.2 deprecates.
+ *
  * Open state is exposed on the region as `data-state` (`open`/`closed`) — a CSS
- * hook, not an ARIA one. `aria-expanded` is deliberately *not* set on the region
- * because it is a generic container, not a role that supports that state (doing so
- * is an ARIA violation); the region's static `aria-haspopup="menu"` advertises the
- * popup, and assistive tech perceives the open state when focus moves into the
- * `role="menu"`.
+ * hook, not an ARIA one. `aria-expanded` is deliberately *not* set on the region:
+ * the role is the author's, and ARIA 1.2 lists neither `generic` nor `group`
+ * among the roles that support that state. Assistive tech perceives the open
+ * state when focus moves into the `role="menu"`.
  *
  * Behavior provided:
  * - `contextmenu` on the region suppresses the browser menu and opens this one at
@@ -45,8 +59,17 @@ import { Controller } from '@hotwired/stimulus';
  * - On open, focus moves to the first item; the region's `data-state` syncs.
  * - Roving focus inside the menu: `ArrowUp`/`ArrowDown` (wrapping), `Home`/`End`.
  * - Activating an enabled item (click / native `Enter`/`Space` on the button)
- *   closes the menu and restores focus to the region. `aria-disabled` activation
- *   is blocked before consumer click handlers run.
+ *   closes the menu and restores focus to the region. An item that is `hidden`,
+ *   natively `disabled`, or `aria-disabled="true"` itself or through an ancestor
+ *   is not activated on any path, and a click on an `aria-disabled` one is also
+ *   stopped, in a capture listener on the controller element, before the click
+ *   handlers inside that element run. Items can nest, and an event is
+ *   refused when any item holding its target refuses. A click is judged once, in
+ *   that capture pass, so a consumer handler that disables the item while the
+ *   click runs does not take back the activation. The verdict holds only for an
+ *   item that held the click's target when it was taken: an item it was not taken
+ *   for — a handler moved the target into another one — is judged when
+ *   {@link activate} runs, as is any other event.
  * - `Escape` closes and restores focus to the region. While open the menu is a
  *   layer on the shared `EscapeLayer` stack; it claims a press only while
  *   focus is inside the controller or fell to the body, so one keypress closes
@@ -66,10 +89,11 @@ import { Controller } from '@hotwired/stimulus';
  *   normalization in {@link connect}, a region or a menu that takes over, and
  *   {@link disconnect} are all silent.
  *
- * Roving focus skips `hidden` and natively `disabled` items. An
- * `aria-disabled="true"` item stays reachable by arrow keys — APG marks that
- * attribute precisely for controls that must remain discoverable — while its
- * activation is suppressed, so it announces itself and does nothing.
+ * Roving focus skips `hidden` and natively `disabled` items. An item that
+ * `aria-disabled="true"` reaches, on the item or an ancestor, stays reachable by
+ * arrow keys — APG marks that attribute precisely for controls that must remain
+ * discoverable — while its activation is suppressed, so it announces itself and
+ * does nothing.
  */
 declare class ContextMenuController extends Controller<HTMLElement> {
     #private;
@@ -114,8 +138,19 @@ declare class ContextMenuController extends Controller<HTMLElement> {
     onRegionKeydown(event: KeyboardEvent): void;
     /** Roving focus and closing keys inside the menu. */
     onItemKeydown(event: KeyboardEvent): void;
-    /** Closes after an item is activated and restores focus to the region. */
-    activate(): void;
+    /**
+     * Closes after an item is activated and restores focus to the region. An event
+     * whose target lies in an item that is `hidden`, natively `disabled`, or
+     * `aria-disabled="true"` itself or through an ancestor does nothing: the menu
+     * stays open, nothing is dispatched and focus stays where it is. Every item
+     * holding the target counts, so an item nested in another one refuses for both,
+     * wherever the action is bound. A click is judged as its capture pass found the
+     * items, before the handlers inside the controller element ran, when the
+     * item this resolves was among them; an item that was not, and any other event, is
+     * judged when this runs.
+     * An event that resolves to no item, and a call with no event, always close.
+     */
+    activate(event?: Event): void;
 }
 
 export { ContextMenuController };

package/dist/controllers/context_menu_controller.js

@@ -22,21 +22,42 @@ function actionSource(source) {
   };
 }
 
+function isAriaDisabled(element) {
+  for (let current = element; current; current = current.parentElement) {
+    if (current.getAttribute("aria-disabled") === "true") return true;
+  }
+  return false;
+}
+
 function isReservedArrowChord(event, allow = []) {
   if (!event.key.startsWith("Arrow")) return false;
   return event.altKey && !allow.includes("alt") || event.ctrlKey && !allow.includes("ctrl") || event.metaKey && !allow.includes("meta") || event.shiftKey && !allow.includes("shift");
 }
+function hasModifierChord(event) {
+  return event.altKey || event.ctrlKey || event.metaKey || event.shiftKey;
+}
+
+function setAttributeIfChanged(element, name, value, beforeWrite) {
+  if (element.getAttribute(name) === value) return false;
+  if (value === null) element.removeAttribute(name);
+  else element.setAttribute(name, value);
+  return true;
+}
 
 function sharedRegistry(key, create) {
   const symbol = Symbol.for(key);
   const scope = globalThis;
   const existing = scope[symbol];
   if (existing !== void 0) return existing;
-  const registry = create();
-  Object.defineProperty(globalThis, symbol, { value: registry });
-  return registry;
+  const registry2 = create();
+  Object.defineProperty(globalThis, symbol, { value: registry2 });
+  return registry2;
 }
 
+var registry = sharedRegistry(
+  "stimeo-ui.attribute-lease.registry.v1",
+  () => ({ stacks: /* @__PURE__ */ new WeakMap(), names: /* @__PURE__ */ new Map() })
+);
 function isAttributeValue(value) {
   return value === null || typeof value === "string";
 }
@@ -53,24 +74,46 @@ function readLeaseRecord(element, record) {
     return void 0;
   }
 }
-var AttributeLease = class _AttributeLease {
-  static #registry = sharedRegistry(
-    "stimeo-ui.attribute-lease.registry.v1",
-    () => ({ stacks: /* @__PURE__ */ new WeakMap(), names: /* @__PURE__ */ new Map() })
-  );
+function attributeStack(element, attribute) {
+  const byAttribute = registry.stacks.get(element) ?? /* @__PURE__ */ new Map();
+  registry.stacks.set(element, byAttribute);
+  const known = byAttribute.get(attribute);
+  if (known) return known;
+  const found = [];
+  for (const record of registry.names.get(attribute) ?? []) {
+    const read = readLeaseRecord(element, record);
+    if (read) found.push({ ...read, record });
+  }
+  const depth = ({ beneath }) => beneath.filter((name) => found.some((other) => other.record === name)).length;
+  const stack = found.sort((one, other) => depth(one) - depth(other)).map(({ record, written, original, linked }, index) => ({
+    lease: null,
+    record,
+    written,
+    original,
+    linked: linked && index > 0
+  }));
+  byAttribute.set(attribute, stack);
+  return stack;
+}
+function findHold(stack, lease, record) {
+  return stack.find((held) => held.lease === lease) ?? stack.find((held) => held.lease === null && held.record === record);
+}
+var AttributeLease = class {
   #attribute;
   #record;
   #base;
+  #preserveAuthor;
   #held = /* @__PURE__ */ new Set();
   constructor(attribute, owner, options = {}) {
     this.#attribute = attribute;
     this.#record = `data-${owner}-${attribute}-lease`;
     this.#base = options.base === true;
-    const names = _AttributeLease.#registry.names;
+    this.#preserveAuthor = options.preserveAuthor === true;
+    const names = registry.names;
     names.set(attribute, (names.get(attribute) ?? /* @__PURE__ */ new Set()).add(this.#record));
   }
   write(element, value) {
-    const stack = this.#stack(element);
+    const stack = attributeStack(element, this.#attribute);
     const hold = this.#take(stack) ?? this.#acquire(element, stack);
     this.#held.add(element);
     const shows = !this.#covered(element, stack, hold);
@@ -80,8 +123,8 @@ var AttributeLease = class _AttributeLease {
   }
   return(element) {
     const held = this.#held.delete(element);
-    const known = _AttributeLease.#registry.stacks.get(element)?.has(this.#attribute);
-    const stack = held || known || element.hasAttribute(this.#record) ? this.#stack(element) : [];
+    const known = registry.stacks.get(element)?.has(this.#attribute);
+    const stack = held || known || element.hasAttribute(this.#record) ? attributeStack(element, this.#attribute) : [];
     const hold = this.#take(stack);
     if (!hold) return false;
     const carries = element.getAttribute(this.#attribute) === hold.written;
@@ -99,31 +142,8 @@ var AttributeLease = class _AttributeLease {
   returnAll() {
     for (const element of Array.from(this.#held)) this.return(element);
   }
-  #stack(element) {
-    const stacks = _AttributeLease.#registry.stacks;
-    const byAttribute = stacks.get(element) ?? /* @__PURE__ */ new Map();
-    stacks.set(element, byAttribute);
-    const stack = byAttribute.get(this.#attribute) ?? this.#seed(element);
-    byAttribute.set(this.#attribute, stack);
-    return stack;
-  }
-  #seed(element) {
-    const found = [];
-    for (const record of _AttributeLease.#registry.names.get(this.#attribute) ?? []) {
-      const read = readLeaseRecord(element, record);
-      if (read) found.push({ ...read, record });
-    }
-    const depth = ({ beneath }) => beneath.filter((name) => found.some((other) => other.record === name)).length;
-    return found.sort((one, other) => depth(one) - depth(other)).map(({ record, written, original, linked }, index) => ({
-      lease: null,
-      record,
-      written,
-      original,
-      linked: linked && index > 0
-    }));
-  }
   #take(stack) {
-    const hold = stack.find((held) => held.lease === this) ?? stack.find((held) => held.lease === null && held.record === this.#record);
+    const hold = findHold(stack, this, this.#record);
     if (hold) hold.lease = this;
     return hold;
   }
@@ -132,7 +152,7 @@ var AttributeLease = class _AttributeLease {
     const top = stack.at(-1);
     const bottom = stack[0];
     const over = top?.written === current ? top : void 0;
-    const from = this.#base ? bottom : over;
+    const from = this.#base ? this.#preserveAuthor && !stack.some((held) => held.written === current) ? void 0 : bottom : over;
     const hold = {
       lease: this,
       record: this.#record,
@@ -162,15 +182,23 @@ var AttributeLease = class _AttributeLease {
       );
     });
     for (const [name, recorded] of records) {
-      if (element.getAttribute(name) === recorded) continue;
-      if (recorded === null) element.removeAttribute(name);
-      else element.setAttribute(name, recorded);
+      setAttributeIfChanged(element, name, recorded);
     }
   }
   #reflect(element, value) {
-    if (element.getAttribute(this.#attribute) === value) return;
-    if (value === null) element.removeAttribute(this.#attribute);
-    else element.setAttribute(this.#attribute, value);
+    setAttributeIfChanged(element, this.#attribute, value);
+  }
+};
+
+var ClickVerdicts = class {
+  #verdicts = /* @__PURE__ */ new WeakMap();
+  record(event, entries, refused) {
+    this.#verdicts.set(event, { entries, refused });
+  }
+  for(event, entry) {
+    const verdict = event && this.#verdicts.get(event);
+    if (!verdict?.entries.includes(entry)) return void 0;
+    return verdict.refused;
   }
 };
 
@@ -188,25 +216,25 @@ var EscapeLayer = class _EscapeLayer {
   #active = null;
   activate(ownerDocument = document, options) {
     this.deactivate();
-    let registry = _EscapeLayer.#registries.get(ownerDocument);
-    if (!registry) {
-      registry = _EscapeLayer.#createRegistry();
-      _EscapeLayer.#registries.set(ownerDocument, registry);
-      ownerDocument.addEventListener("keydown", registry.onKeydown);
+    let registry2 = _EscapeLayer.#registries.get(ownerDocument);
+    if (!registry2) {
+      registry2 = _EscapeLayer.#createRegistry();
+      _EscapeLayer.#registries.set(ownerDocument, registry2);
+      ownerDocument.addEventListener("keydown", registry2.onKeydown);
     }
     const entry = { onDismiss: options.onDismiss, claims: options.claims ?? null };
-    registry.stack.push(entry);
+    registry2.stack.push(entry);
     this.#active = { document: ownerDocument, entry };
   }
   deactivate() {
     const active = this.#active;
     if (!active) return;
-    const registry = _EscapeLayer.#registries.get(active.document);
-    if (registry) {
-      const index = registry.stack.lastIndexOf(active.entry);
-      if (index >= 0) registry.stack.splice(index, 1);
-      if (registry.stack.length === 0) {
-        active.document.removeEventListener("keydown", registry.onKeydown);
+    const registry2 = _EscapeLayer.#registries.get(active.document);
+    if (registry2) {
+      const index = registry2.stack.lastIndexOf(active.entry);
+      if (index >= 0) registry2.stack.splice(index, 1);
+      if (registry2.stack.length === 0) {
+        active.document.removeEventListener("keydown", registry2.onKeydown);
         _EscapeLayer.#registries.delete(active.document);
       }
     }
@@ -215,22 +243,22 @@ var EscapeLayer = class _EscapeLayer {
   get ownsEscape() {
     const active = this.#active;
     if (!active) return false;
-    const registry = _EscapeLayer.#registries.get(active.document);
-    if (!registry) return false;
-    return _EscapeLayer.#resolveOwner(registry.stack) === active.entry;
+    const registry2 = _EscapeLayer.#registries.get(active.document);
+    if (!registry2) return false;
+    return _EscapeLayer.#resolveOwner(registry2.stack) === active.entry;
   }
   static #createRegistry() {
-    const registry = {
+    const registry2 = {
       stack: [],
       onKeydown: (event) => {
         if (event.key !== "Escape" || event.defaultPrevented || event.isComposing) return;
-        const owner = _EscapeLayer.#resolveOwner(registry.stack);
+        const owner = _EscapeLayer.#resolveOwner(registry2.stack);
         if (!owner) return;
         event.preventDefault();
         owner.onDismiss();
       }
     };
-    return registry;
+    return registry2;
   }
   static #resolveOwner(stack) {
     for (let index = stack.length - 1; index >= 0; index--) {
@@ -243,6 +271,29 @@ var EscapeLayer = class _EscapeLayer {
   }
 };
 
+function ownerIndex(candidates, node) {
+  if (!(node instanceof Node)) return -1;
+  return candidates.findIndex((candidate) => candidate.contains(node));
+}
+function ownerOf(candidates, node) {
+  return candidates[ownerIndex(candidates, node)] ?? null;
+}
+function ownersOf(candidates, node) {
+  if (!(node instanceof Node)) return [];
+  return candidates.filter((candidate) => candidate.contains(node));
+}
+
+var ListenerSet = class {
+  #abort = new AbortController();
+  add(target, type, handler, options) {
+    target.addEventListener(type, handler, { ...options, signal: this.#abort.signal });
+  }
+  dispose() {
+    this.#abort.abort();
+    this.#abort = new AbortController();
+  }
+};
+
 var TimerRegistry = class {
   ids = /* @__PURE__ */ new Set();
   clear(id) {
@@ -289,11 +340,13 @@ var ContextMenuController = class _ContextMenuController extends Controller {
   #menu = null;
   #connected = false;
   #reporting = false;
+  #clickVerdicts = new ClickVerdicts();
+  #listeners = new ListenerSet();
   connect() {
     this.#closeMenu("api");
-    this.element.addEventListener("click", this.#onItemClickCapture, true);
-    document.addEventListener("click", this.#onOutsidePointer, true);
-    document.addEventListener("contextmenu", this.#onOutsidePointer, true);
+    this.#listeners.add(this.element, "click", this.#onItemClickCapture, { capture: true });
+    this.#listeners.add(document, "click", this.#onOutsidePointer, { capture: true });
+    this.#listeners.add(document, "contextmenu", this.#onOutsidePointer, { capture: true });
     this.#connected = true;
     this.#reporting = true;
   }
@@ -302,9 +355,7 @@ var ContextMenuController = class _ContextMenuController extends Controller {
     this.#reporting = false;
     this.#timers.clearAll();
     this.#escapeLayer.deactivate();
-    this.element.removeEventListener("click", this.#onItemClickCapture, true);
-    document.removeEventListener("click", this.#onOutsidePointer, true);
-    document.removeEventListener("contextmenu", this.#onOutsidePointer, true);
+    this.#listeners.dispose();
   }
   regionTargetConnected() {
     if (this.#connected) this.#reflectRegion();
@@ -342,6 +393,7 @@ var ContextMenuController = class _ContextMenuController extends Controller {
   onItemKeydown(event) {
     if (event.defaultPrevented) return;
     if (isReservedArrowChord(event)) return;
+    if ((event.key === "Home" || event.key === "End") && hasModifierChord(event)) return;
     const items = this.#navigableItems;
     const currentIndex = items.indexOf(event.currentTarget);
     switch (event.key) {
@@ -373,9 +425,18 @@ var ContextMenuController = class _ContextMenuController extends Controller {
         break;
     }
   }
-  activate() {
+  activate(event) {
+    const item = ownerOf(this.itemTargets, event?.target);
+    if (item !== null && this.#refuses(item, event)) return;
     this.#closeAndRestore("select");
   }
+  #refuses(item, event) {
+    const recorded = this.#clickVerdicts.for(event, item);
+    if (recorded !== void 0) return recorded;
+    return ownersOf(this.itemTargets, event?.target).some(
+      (owner) => this.#isActivationDisabled(owner)
+    );
+  }
   #openAt(x, y, reason) {
     if (!this.hasMenuTarget) return;
     this.#timers.clearAll();
@@ -435,12 +496,13 @@ var ContextMenuController = class _ContextMenuController extends Controller {
     if (this.#isOpen && !this.element.contains(event.target)) this.#closeMenu("outside");
   };
   #onItemClickCapture = (event) => {
-    const target = event.target;
-    if (!(target instanceof Node)) return;
-    const disabled = this.itemTargets.some(
-      (item) => item.getAttribute("aria-disabled") === "true" && item.contains(target)
+    const items = ownersOf(this.itemTargets, event.target);
+    this.#clickVerdicts.record(
+      event,
+      items,
+      items.some((item) => this.#isActivationDisabled(item))
     );
-    if (!disabled) return;
+    if (!items.some((item) => isAriaDisabled(item))) return;
     event.preventDefault();
     event.stopImmediatePropagation();
   };
@@ -451,6 +513,9 @@ var ContextMenuController = class _ContextMenuController extends Controller {
     if (item.hasAttribute("hidden")) return false;
     return !item.disabled;
   }
+  #isActivationDisabled(item) {
+    return !this.#isNavigable(item) || isAriaDisabled(item);
+  }
   get #isOpen() {
     return this.hasMenuTarget && !this.menuTarget.hidden;
   }