stimeo-ui 0.16.0 → 0.18.0

package/dist/controllers/navigation_menu_controller.d.ts

@@ -5,7 +5,7 @@ import { Controller } from '@hotwired/stimulus';
  *
  * Markup contract (identifier: `stimeo--navigation-menu`):
  *   <nav data-controller="stimeo--navigation-menu" aria-label="Main">
- *     <ul>
+ *     <ul data-stimeo--navigation-menu-target="list">
  *       <li>
  *         <button data-stimeo--navigation-menu-target="trigger"
  *                 aria-expanded="false" aria-controls="nav-products"
@@ -32,8 +32,9 @@ import { Controller } from '@hotwired/stimulus';
  * destination, closes it. `ArrowLeft`/`ArrowRight` move focus between the
  * *navigable* triggers without rewriting `tabindex` (they keep their natural Tab
  * order); a modified press (`Alt`/`Ctrl`/`Meta`/`Shift`, e.g. the browser's
- * `Alt+←` history back) is left to the browser. Hover open/close is opt-in via
- * `openOnHover`.
+ * `Alt+←` history back) is left to the browser. `ArrowLeft`/`ArrowRight` follow
+ * the writing direction of the optional `list` target, or of the root while there
+ * is none. Hover open/close is opt-in via `openOnHover`.
  *
  * Every `panel` must be a **descendant of the nav element**: Stimulus resolves
  * targets within the controller's own scope, so a panel moved outside it (a
@@ -42,8 +43,9 @@ import { Controller } from '@hotwired/stimulus';
  * By default the hover region is each trigger and its panel. An optional
  * `hoverArea` target widens it: mark a wrapper that contains **exactly one**
  * trigger (e.g. the `<li>` holding a top-level *link*, its disclosure button, and
- * its panel — the APG "Disclosure Navigation with Top-Level Links" arrangement)
- * and hovering anywhere over that wrapper opens the contained trigger's panel.
+ * its panel — the arrangement of the APG example
+ * "Disclosure (Show/Hide) Navigation Menu with Top-Level Links") and hovering
+ * anywhere over that wrapper opens the contained trigger's panel.
  * Wrapping several triggers at once (marking the whole `<ul>`, say) is not
  * supported: every hover over the area then resolves to the *first* contained
  * trigger. A trigger or panel inside a `hoverArea` defers to the wrapper (its own
@@ -97,11 +99,20 @@ declare class NavigationMenuController extends Controller<HTMLElement> {
             default: number;
         };
     };
+    static valueConstraints: {
+        hoverDelay: {
+            readonly finite: true;
+            readonly min: 0;
+            readonly max: 2147483647;
+        };
+    };
     static actions: readonly ["onTriggerKeydown", "toggle"];
     static events: readonly ["close", "open"];
     readonly triggerTargets: HTMLElement[];
     readonly panelTargets: HTMLElement[];
     readonly hoverAreaTargets: HTMLElement[];
+    readonly listTarget: HTMLElement;
+    readonly hasListTarget: boolean;
     openOnHoverValue: boolean;
     hoverDelayValue: number;
     /** Establishes the closed baseline and the dismissal listeners. */
@@ -139,8 +150,18 @@ declare class NavigationMenuController extends Controller<HTMLElement> {
      * would be unopenable until the pointer left and came back. Keyboard
      * activation (pointer elsewhere) still toggles it closed, and `Escape` and
      * outside clicks dismiss either way.
+     *
+     * A trigger that is `hidden`, natively `disabled` or `aria-disabled` (itself or
+     * through an ancestor) never opens, whether this receives a DOM event of any
+     * type or an explicit element: the refusal leaves an open panel open and reports
+     * nothing, and only the pending hover timer is dropped, as for every explicit
+     * activation. Nor does a trigger whose target lies inside a nested trigger that
+     * refuses. A click keeps the verdict taken as it started, before the handlers
+     * inside the nav element ran, when the trigger held its target then; a trigger that
+     * verdict was not taken for, and anything else, is judged now. A panel already open
+     * behind such a trigger still closes.
      */
-    toggle(event: Event): void;
+    toggle(source: Event | HTMLElement): void;
     /**
      * `ArrowLeft`/`ArrowRight` move focus between triggers (keeping Tab order).
      *