ngwr 14.9.1 → 14.11.0

package/types/ngwr-dropdown-testing.d.ts

@@ -1,38 +1,22 @@
-import { BaseHarnessFilters, ComponentHarness, HarnessPredicate, ContentContainerComponentHarness, HarnessLoader } from '@angular/cdk/testing';
-
-/**
- * @license
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
- */
-
+import { BaseHarnessFilters, ComponentHarness, ContentContainerComponentHarness, HarnessLoader, HarnessPredicate } from "@angular/cdk/testing";
 /** Narrows which `[wrDropdown]` trigger a harness query matches. */
 interface WrDropdownHarnessFilters extends BaseHarnessFilters {
-    /**
-     * Match the trigger's visible text — the label of whatever element the
-     * consumer put `[wrDropdown]` on. A string is an exact match, a RegExp is
-     * tested.
-     */
-    readonly text?: string | RegExp;
-    /** Match only open (`true`) or only closed (`false`) dropdowns. */
-    readonly open?: boolean;
+  /**
+   * Match the trigger's visible text — the label of whatever element the
+   * consumer put `[wrDropdown]` on. A string is an exact match, a RegExp is
+   * tested.
+   */
+  readonly text?: string | RegExp;
+  /** Match only open (`true`) or only closed (`false`) dropdowns. */
+  readonly open?: boolean;
 }
 /** Narrows which item inside a dropdown's menu a harness query matches. */
 interface WrDropdownItemHarnessFilters extends BaseHarnessFilters {
-    /** Match the item's label — a string is an exact match, a RegExp is tested. */
-    readonly text?: string | RegExp;
-    /** Match only enabled (`false`) or only disabled (`true`) items. */
-    readonly disabled?: boolean;
+  /** Match the item's label — a string is an exact match, a RegExp is tested. */
+  readonly text?: string | RegExp;
+  /** Match only enabled (`false`) or only disabled (`true`) items. */
+  readonly disabled?: boolean;
 }
-
-/**
- * @license
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
- */
-
 /**
  * Test harness for one `<wr-dropdown-item>` inside a dropdown menu.
  *
@@ -45,43 +29,35 @@ interface WrDropdownItemHarnessFilters extends BaseHarnessFilters {
  *
  * @see https://ngwr.dev/guides/testing
  */
-declare class WrDropdownItemHarness extends ComponentHarness {
-    /** The class the item paints on its host, and the one arrow-key navigation looks for. */
-    static hostSelector: string;
-    /** Build a predicate that narrows the query. */
-    static with(options?: WrDropdownItemHarnessFilters): HarnessPredicate<WrDropdownItemHarness>;
-    /** The item's label, trimmed. A leading icon is not part of it. */
-    getText(): Promise<string>;
-    /** The role the item announces — `menuitem`. */
-    getRole(): Promise<string | null>;
-    /** Whether the item refuses activation. */
-    isDisabled(): Promise<boolean>;
-    /** Whether the item shows a leading icon. */
-    hasIcon(): Promise<boolean>;
-    /** The leading icon's registered name, or `null` when the item has no icon. */
-    getIconName(): Promise<string | null>;
-    /** Whether the item holds the menu's roving focus. */
-    isFocused(): Promise<boolean>;
-    /**
-     * Click the item. A disabled item throws instead.
-     *
-     * Refusing is the only honest answer: the item's own `disabled` guards the
-     * KEYBOARD path only, and a pointer is stopped by `pointer-events: none` in the
-     * stylesheet. jsdom loads no stylesheets, so a click dispatched here would land
-     * on the host — exactly where the consumer bound `(click)` — and the spec would
-     * record an activation that cannot happen in a browser. Assert `isDisabled()`
-     * instead.
-     */
-    click(): Promise<void>;
+export declare class WrDropdownItemHarness extends ComponentHarness {
+  /** The class the item paints on its host, and the one arrow-key navigation looks for. */
+  static hostSelector: string;
+  /** Build a predicate that narrows the query. */
+  static with(options?: WrDropdownItemHarnessFilters): HarnessPredicate<WrDropdownItemHarness>;
+  /** The item's label, trimmed. A leading icon is not part of it. */
+  getText(): Promise<string>;
+  /** The role the item announces — `menuitem`. */
+  getRole(): Promise<string | null>;
+  /** Whether the item refuses activation. */
+  isDisabled(): Promise<boolean>;
+  /** Whether the item shows a leading icon. */
+  hasIcon(): Promise<boolean>;
+  /** The leading icon's registered name, or `null` when the item has no icon. */
+  getIconName(): Promise<string | null>;
+  /** Whether the item holds the menu's roving focus. */
+  isFocused(): Promise<boolean>;
+  /**
+   * Click the item. A disabled item throws instead.
+   *
+   * Refusing is the only honest answer: the item's own `disabled` guards the
+   * KEYBOARD path only, and a pointer is stopped by `pointer-events: none` in the
+   * stylesheet. jsdom loads no stylesheets, so a click dispatched here would land
+   * on the host — exactly where the consumer bound `(click)` — and the spec would
+   * record an activation that cannot happen in a browser. Assert `isDisabled()`
+   * instead.
+   */
+  click(): Promise<void>;
 }
-
-/**
- * @license
- *
- * Use of this source code is governed by an MIT-style license that can be
- * found in the LICENSE file at https://github.com/thekhegay/ngwr/blob/main/LICENSE
- */
-
 /**
  * Test harness for `[wrDropdown]` — the trigger, and the menu it opens.
  *
@@ -110,93 +86,91 @@ declare class WrDropdownItemHarness extends ComponentHarness {
  *
  * @see https://ngwr.dev/guides/testing
  */
-declare class WrDropdownHarness extends ContentContainerComponentHarness {
-    /** The directive's host — whatever element the consumer put `[wrDropdown]` on. */
-    static hostSelector: string;
-    /** Build a predicate that narrows the query. */
-    static with(options?: WrDropdownHarnessFilters): HarnessPredicate<WrDropdownHarness>;
-    /** The trigger's visible text. */
-    getTriggerText(): Promise<string>;
-    /** Whether the menu is showing. */
-    isOpen(): Promise<boolean>;
-    /** The role the menu announces — `menu`. Throws while the menu is closed. */
-    getMenuRole(): Promise<string | null>;
-    /**
-     * Whether the menu takes its accessible name from this trigger.
-     *
-     * The menu carries no label of its own, so that reference IS its name — and the
-     * id it points at is generated unless the consumer named the trigger
-     * themselves, which is why a spec cannot simply hard-code one.
-     */
-    isMenuLabelledByTrigger(): Promise<boolean>;
-    /**
-     * Open the menu, whichever gesture this dropdown listens for.
-     *
-     * `trigger` is not reflected in the DOM, so the harness cannot ask which mode it
-     * is in: it moves the pointer on first and falls back to a click. Hover leads
-     * because a click is an outside pointer event for every OTHER open overlay — so
-     * leading with it would shut someone else's menu on the way to opening this one
-     * — and a `trigger="click"` dropdown ignores the hover outright.
-     */
-    open(): Promise<void>;
-    /**
-     * Open the menu from the keyboard — ArrowDown on the trigger, the APG
-     * menu-button path (ArrowUp / Enter / Space do the same).
-     *
-     * Worth its own method rather than an argument to `open()`: it is the only way
-     * to get TWO dropdowns open at once, because clicking a second trigger is an
-     * outside pointer event for the first and closes it.
-     */
-    openByKeyboard(): Promise<void>;
-    /** Close the menu. A closed dropdown is left alone. */
-    close(): Promise<void>;
-    /** Click the trigger. A `trigger="hover"` dropdown deliberately ignores this. */
-    clickTrigger(): Promise<void>;
-    /** Move the pointer onto the trigger. Opens a `trigger="hover"` dropdown. */
-    hoverTrigger(): Promise<void>;
-    /** Move the pointer off the trigger. Closes a `trigger="hover"` dropdown. */
-    mouseAwayFromTrigger(): Promise<void>;
-    /**
-     * The items in this dropdown's menu, in DOM order.
-     *
-     * Throws while the menu is closed: the items do not exist anywhere until the
-     * portal is attached, and an empty array reads like a menu that rendered
-     * nothing — a failure three lines later instead of here.
-     */
-    getItems(filters?: WrDropdownItemHarnessFilters): Promise<WrDropdownItemHarness[]>;
-    /** The labels of the items in this dropdown's menu, in DOM order. */
-    getItemTexts(): Promise<string[]>;
-    /**
-     * Open the menu if it is closed, then click the first item matching the filters.
-     *
-     * Picking does NOT close the menu — there is no close-on-select in the item or
-     * the menu, so a consumer who wants one calls `close()` themselves.
-     */
-    clickItem(filters: WrDropdownItemHarnessFilters): Promise<void>;
-    /**
-     * The label of the item that currently holds focus, or `null` when focus is
-     * elsewhere.
-     *
-     * The menu roves focus rather than moving a visual cursor — it lands on the
-     * first ENABLED item as the menu renders, and the arrow keys walk it from there
-     * over the enabled items only (a disabled one is not a stop) — so this is the
-     * only way to ask where the keyboard is.
-     */
-    getFocusedItemText(): Promise<string | null>;
-    /**
-     * A loader scoped to THIS dropdown's menu — the content loader every
-     * `HarnessLoader` method on this class runs through, `getItems()` included.
-     *
-     * Scoped by the published id rather than by `.wr-dropdown-menu`: the overlay
-     * container is shared, so a bare class query would answer with whichever
-     * dropdown happened to open first.
-     */
-    protected getRootHarnessLoader(): Promise<HarnessLoader>;
-    /** This dropdown's menu element in the overlay. */
-    private menu;
-    /** The id the trigger publishes as `aria-controls`, which its menu carries. */
-    private menuId;
+export declare class WrDropdownHarness extends ContentContainerComponentHarness {
+  /** The directive's host — whatever element the consumer put `[wrDropdown]` on. */
+  static hostSelector: string;
+  /** Build a predicate that narrows the query. */
+  static with(options?: WrDropdownHarnessFilters): HarnessPredicate<WrDropdownHarness>;
+  /** The trigger's visible text. */
+  getTriggerText(): Promise<string>;
+  /** Whether the menu is showing. */
+  isOpen(): Promise<boolean>;
+  /** The role the menu announces — `menu`. Throws while the menu is closed. */
+  getMenuRole(): Promise<string | null>;
+  /**
+   * Whether the menu takes its accessible name from this trigger.
+   *
+   * The menu carries no label of its own, so that reference IS its name — and the
+   * id it points at is generated unless the consumer named the trigger
+   * themselves, which is why a spec cannot simply hard-code one.
+   */
+  isMenuLabelledByTrigger(): Promise<boolean>;
+  /**
+   * Open the menu, whichever gesture this dropdown listens for.
+   *
+   * `trigger` is not reflected in the DOM, so the harness cannot ask which mode it
+   * is in: it moves the pointer on first and falls back to a click. Hover leads
+   * because a click is an outside pointer event for every OTHER open overlay — so
+   * leading with it would shut someone else's menu on the way to opening this one
+   * — and a `trigger="click"` dropdown ignores the hover outright.
+   */
+  open(): Promise<void>;
+  /**
+   * Open the menu from the keyboard — ArrowDown on the trigger, the APG
+   * menu-button path (ArrowUp / Enter / Space do the same).
+   *
+   * Worth its own method rather than an argument to `open()`: it is the only way
+   * to get TWO dropdowns open at once, because clicking a second trigger is an
+   * outside pointer event for the first and closes it.
+   */
+  openByKeyboard(): Promise<void>;
+  /** Close the menu. A closed dropdown is left alone. */
+  close(): Promise<void>;
+  /** Click the trigger. A `trigger="hover"` dropdown deliberately ignores this. */
+  clickTrigger(): Promise<void>;
+  /** Move the pointer onto the trigger. Opens a `trigger="hover"` dropdown. */
+  hoverTrigger(): Promise<void>;
+  /** Move the pointer off the trigger. Closes a `trigger="hover"` dropdown. */
+  mouseAwayFromTrigger(): Promise<void>;
+  /**
+   * The items in this dropdown's menu, in DOM order.
+   *
+   * Throws while the menu is closed: the items do not exist anywhere until the
+   * portal is attached, and an empty array reads like a menu that rendered
+   * nothing — a failure three lines later instead of here.
+   */
+  getItems(filters?: WrDropdownItemHarnessFilters): Promise<WrDropdownItemHarness[]>;
+  /** The labels of the items in this dropdown's menu, in DOM order. */
+  getItemTexts(): Promise<string[]>;
+  /**
+   * Open the menu if it is closed, then click the first item matching the filters.
+   *
+   * Picking does NOT close the menu — there is no close-on-select in the item or
+   * the menu, so a consumer who wants one calls `close()` themselves.
+   */
+  clickItem(filters: WrDropdownItemHarnessFilters): Promise<void>;
+  /**
+   * The label of the item that currently holds focus, or `null` when focus is
+   * elsewhere.
+   *
+   * The menu roves focus rather than moving a visual cursor — it lands on the
+   * first ENABLED item as the menu renders, and the arrow keys walk it from there
+   * over the enabled items only (a disabled one is not a stop) — so this is the
+   * only way to ask where the keyboard is.
+   */
+  getFocusedItemText(): Promise<string | null>;
+  /**
+   * A loader scoped to THIS dropdown's menu — the content loader every
+   * `HarnessLoader` method on this class runs through, `getItems()` included.
+   *
+   * Scoped by the published id rather than by `.wr-dropdown-menu`: the overlay
+   * container is shared, so a bare class query would answer with whichever
+   * dropdown happened to open first.
+   */
+  protected getRootHarnessLoader(): Promise<HarnessLoader>;
+  /** This dropdown's menu element in the overlay. */
+  private menu;
+  /** The id the trigger publishes as `aria-controls`, which its menu carries. */
+  private menuId;
 }
-
-export { WrDropdownHarness, WrDropdownItemHarness };
-export type { WrDropdownHarnessFilters, WrDropdownItemHarnessFilters };
+export type { WrDropdownHarnessFilters, WrDropdownItemHarnessFilters };