@angular/material 19.2.2 → 19.2.3

package/list/testing/index.d.ts

@@ -1,19 +1,16 @@
-import { BaseHarnessFilters } from '@angular/cdk/testing';
-import { ComponentHarness } from '@angular/cdk/testing';
-import { ComponentHarnessConstructor } from '@angular/cdk/testing';
-import { ContentContainerComponentHarness } from '@angular/cdk/testing';
-import { DividerHarnessFilters } from '@angular/material/divider/testing';
-import { HarnessPredicate } from '@angular/cdk/testing';
-import { MatDividerHarness } from '@angular/material/divider/testing';
+import { BaseHarnessFilters, ComponentHarness, HarnessPredicate, ContentContainerComponentHarness, ComponentHarnessConstructor } from '@angular/cdk/testing';
+import { DividerHarnessFilters, MatDividerHarness } from '@angular/material/divider/testing';
 import { MatListOptionTogglePosition } from '@angular/material/list';
 
-export declare interface ActionListHarnessFilters extends BaseHarnessFilters {
+interface ListHarnessFilters extends BaseHarnessFilters {
 }
-
-export declare interface ActionListItemHarnessFilters extends BaseListItemHarnessFilters {
+interface ActionListHarnessFilters extends BaseHarnessFilters {
 }
-
-export declare interface BaseListItemHarnessFilters extends BaseHarnessFilters {
+interface NavListHarnessFilters extends BaseHarnessFilters {
+}
+interface SelectionListHarnessFilters extends BaseHarnessFilters {
+}
+interface BaseListItemHarnessFilters extends BaseHarnessFilters {
     title?: string | RegExp;
     secondaryText?: string | RegExp | null;
     tertiaryText?: string | RegExp | null;
@@ -24,73 +21,90 @@ export declare interface BaseListItemHarnessFilters extends BaseHarnessFilters {
      */
     text?: string | RegExp;
 }
-
-export declare interface ListHarnessFilters extends BaseHarnessFilters {
+interface ListItemHarnessFilters extends BaseListItemHarnessFilters {
 }
-
-export declare interface ListItemHarnessFilters extends BaseListItemHarnessFilters {
+interface ActionListItemHarnessFilters extends BaseListItemHarnessFilters {
 }
-
-export declare interface ListOptionHarnessFilters extends BaseListItemHarnessFilters {
+interface NavListItemHarnessFilters extends BaseListItemHarnessFilters {
+    href?: string | RegExp | null;
+    activated?: boolean;
+}
+interface ListOptionHarnessFilters extends BaseListItemHarnessFilters {
     selected?: boolean;
 }
-
-/** Represents a section of a list falling under a specific header. */
-declare interface ListSection<I> {
-    /** The heading for this list section. `undefined` if there is no heading. */
-    heading?: string;
-    /** The items in this list section. */
-    items: I[];
+interface SubheaderHarnessFilters extends BaseHarnessFilters {
+    text?: string | RegExp;
 }
 
-/** Harness for interacting with a action-list in tests. */
-export declare class MatActionListHarness extends MatListHarnessBase<typeof MatActionListItemHarness, MatActionListItemHarness, ActionListItemHarnessFilters> {
-    /** The selector for the host element of a `MatActionList` instance. */
+/** Harness for interacting with a list subheader. */
+declare class MatSubheaderHarness extends ComponentHarness {
     static hostSelector: string;
+    static with(options?: SubheaderHarnessFilters): HarnessPredicate<MatSubheaderHarness>;
+    /** Gets the full text content of the list item (including text from any font icons). */
+    getText(): Promise<string>;
+}
+/** Selectors for the various list item sections that may contain user content. */
+declare enum MatListItemSection {
+    CONTENT = ".mdc-list-item__content"
+}
+/** Enum describing the possible variants of a list item. */
+declare enum MatListItemType {
+    ONE_LINE_ITEM = 0,
+    TWO_LINE_ITEM = 1,
+    THREE_LINE_ITEM = 2
+}
+/**
+ * Shared behavior among the harnesses for the various `MatListItem` flavors.
+ * @docs-private
+ */
+declare abstract class MatListItemHarnessBase extends ContentContainerComponentHarness<MatListItemSection> {
+    private _lines;
+    private _primaryText;
+    private _avatar;
+    private _icon;
+    private _unscopedTextContent;
+    /** Gets the type of the list item, currently describing how many lines there are. */
+    getType(): Promise<MatListItemType>;
     /**
-     * Gets a `HarnessPredicate` that can be used to search for an action list with specific
-     * attributes.
-     * @param options Options for filtering which action list instances are considered a match.
-     * @return a `HarnessPredicate` configured with the given options.
+     * Gets the full text content of the list item, excluding text
+     * from icons and avatars.
+     *
+     * @deprecated Use the `getFullText` method instead.
+     * @breaking-change 16.0.0
      */
-    static with<T extends MatActionListHarness>(this: ComponentHarnessConstructor<T>, options?: ActionListHarnessFilters): HarnessPredicate<T>;
-    _itemHarness: typeof MatActionListItemHarness;
-}
-
-/** Harness for interacting with an action list item. */
-export declare class MatActionListItemHarness extends MatListItemHarnessBase {
-    /** The selector for the host element of a `MatListItem` instance. */
-    static hostSelector: string;
+    getText(): Promise<string>;
     /**
-     * Gets a `HarnessPredicate` that can be used to search for a list item with specific
-     * attributes.
-     * @param options Options for filtering which action list item instances are considered a match.
-     * @return a `HarnessPredicate` configured with the given options.
+     * Gets the full text content of the list item, excluding text
+     * from icons and avatars.
      */
-    static with<T extends MatActionListItemHarness>(this: ComponentHarnessConstructor<T>, options?: ActionListItemHarnessFilters): HarnessPredicate<T>;
-    /** Clicks on the action list item. */
-    click(): Promise<void>;
-    /** Focuses the action list item. */
-    focus(): Promise<void>;
-    /** Blurs the action list item. */
-    blur(): Promise<void>;
-    /** Whether the action list item is focused. */
-    isFocused(): Promise<boolean>;
-}
-
-/** Harness for interacting with a list in tests. */
-export declare class MatListHarness extends MatListHarnessBase<typeof MatListItemHarness, MatListItemHarness, ListItemHarnessFilters> {
-    /** The selector for the host element of a `MatList` instance. */
-    static hostSelector: string;
+    getFullText(): Promise<string>;
+    /** Gets the title of the list item. */
+    getTitle(): Promise<string>;
+    /** Whether the list item is disabled. */
+    isDisabled(): Promise<boolean>;
     /**
-     * Gets a `HarnessPredicate` that can be used to search for a list with specific attributes.
-     * @param options Options for filtering which list instances are considered a match.
-     * @return a `HarnessPredicate` configured with the given options.
+     * Gets the secondary line text of the list item. Null if the list item
+     * does not have a secondary line.
      */
-    static with<T extends MatListHarness>(this: ComponentHarnessConstructor<T>, options?: ListHarnessFilters): HarnessPredicate<T>;
-    _itemHarness: typeof MatListItemHarness;
+    getSecondaryText(): Promise<string | null>;
+    /**
+     * Gets the tertiary line text of the list item. Null if the list item
+     * does not have a tertiary line.
+     */
+    getTertiaryText(): Promise<string | null>;
+    /** Whether this list item has an avatar. */
+    hasAvatar(): Promise<boolean>;
+    /** Whether this list item has an icon. */
+    hasIcon(): Promise<boolean>;
 }
 
+/** Represents a section of a list falling under a specific header. */
+interface ListSection<I> {
+    /** The heading for this list section. `undefined` if there is no heading. */
+    heading?: string;
+    /** The items in this list section. */
+    items: I[];
+}
 /**
  * Shared behavior among the harnesses for the various `MatList` flavors.
  * @template T A constructor type for a list item harness type used by this list harness.
@@ -174,116 +188,66 @@ declare abstract class MatListHarnessBase<T extends ComponentHarnessConstructor<
     }): Promise<(C | MatSubheaderHarness | MatDividerHarness)[]>;
 }
 
-/** Harness for interacting with a list item. */
-export declare class MatListItemHarness extends MatListItemHarnessBase {
-    /** The selector for the host element of a `MatListItem` instance. */
+/** Harness for interacting with a action-list in tests. */
+declare class MatActionListHarness extends MatListHarnessBase<typeof MatActionListItemHarness, MatActionListItemHarness, ActionListItemHarnessFilters> {
+    /** The selector for the host element of a `MatActionList` instance. */
     static hostSelector: string;
     /**
-     * Gets a `HarnessPredicate` that can be used to search for a list item with specific attributes.
-     * @param options Options for filtering which list item instances are considered a match.
+     * Gets a `HarnessPredicate` that can be used to search for an action list with specific
+     * attributes.
+     * @param options Options for filtering which action list instances are considered a match.
      * @return a `HarnessPredicate` configured with the given options.
      */
-    static with<T extends MatListItemHarness>(this: ComponentHarnessConstructor<T>, options?: ListItemHarnessFilters): HarnessPredicate<T>;
-}
-
-/**
- * Shared behavior among the harnesses for the various `MatListItem` flavors.
- * @docs-private
- */
-declare abstract class MatListItemHarnessBase extends ContentContainerComponentHarness<MatListItemSection> {
-    private _lines;
-    private _primaryText;
-    private _avatar;
-    private _icon;
-    private _unscopedTextContent;
-    /** Gets the type of the list item, currently describing how many lines there are. */
-    getType(): Promise<MatListItemType>;
-    /**
-     * Gets the full text content of the list item, excluding text
-     * from icons and avatars.
-     *
-     * @deprecated Use the `getFullText` method instead.
-     * @breaking-change 16.0.0
-     */
-    getText(): Promise<string>;
-    /**
-     * Gets the full text content of the list item, excluding text
-     * from icons and avatars.
-     */
-    getFullText(): Promise<string>;
-    /** Gets the title of the list item. */
-    getTitle(): Promise<string>;
-    /** Whether the list item is disabled. */
-    isDisabled(): Promise<boolean>;
-    /**
-     * Gets the secondary line text of the list item. Null if the list item
-     * does not have a secondary line.
-     */
-    getSecondaryText(): Promise<string | null>;
-    /**
-     * Gets the tertiary line text of the list item. Null if the list item
-     * does not have a tertiary line.
-     */
-    getTertiaryText(): Promise<string | null>;
-    /** Whether this list item has an avatar. */
-    hasAvatar(): Promise<boolean>;
-    /** Whether this list item has an icon. */
-    hasIcon(): Promise<boolean>;
-}
-
-/** Selectors for the various list item sections that may contain user content. */
-export declare enum MatListItemSection {
-    CONTENT = ".mdc-list-item__content"
-}
-
-/** Enum describing the possible variants of a list item. */
-export declare enum MatListItemType {
-    ONE_LINE_ITEM = 0,
-    TWO_LINE_ITEM = 1,
-    THREE_LINE_ITEM = 2
+    static with<T extends MatActionListHarness>(this: ComponentHarnessConstructor<T>, options?: ActionListHarnessFilters): HarnessPredicate<T>;
+    _itemHarness: typeof MatActionListItemHarness;
 }
-
-/** Harness for interacting with a list option. */
-export declare class MatListOptionHarness extends MatListItemHarnessBase {
-    /** The selector for the host element of a `MatListOption` instance. */
+/** Harness for interacting with an action list item. */
+declare class MatActionListItemHarness extends MatListItemHarnessBase {
+    /** The selector for the host element of a `MatListItem` instance. */
     static hostSelector: string;
     /**
-     * Gets a `HarnessPredicate` that can be used to search for a list option with specific
+     * Gets a `HarnessPredicate` that can be used to search for a list item with specific
      * attributes.
-     * @param options Options for filtering which list option instances are considered a match.
+     * @param options Options for filtering which action list item instances are considered a match.
      * @return a `HarnessPredicate` configured with the given options.
      */
-    static with<T extends MatListOptionHarness>(this: ComponentHarnessConstructor<T>, options?: ListOptionHarnessFilters): HarnessPredicate<T>;
-    private _beforeCheckbox;
-    private _beforeRadio;
-    /** Gets the position of the checkbox relative to the list option content. */
-    getCheckboxPosition(): Promise<MatListOptionTogglePosition>;
-    /** Gets the position of the radio relative to the list option content. */
-    getRadioPosition(): Promise<MatListOptionTogglePosition>;
-    /** Whether the list option is selected. */
-    isSelected(): Promise<boolean>;
-    /** Focuses the list option. */
+    static with<T extends MatActionListItemHarness>(this: ComponentHarnessConstructor<T>, options?: ActionListItemHarnessFilters): HarnessPredicate<T>;
+    /** Clicks on the action list item. */
+    click(): Promise<void>;
+    /** Focuses the action list item. */
     focus(): Promise<void>;
-    /** Blurs the list option. */
+    /** Blurs the action list item. */
     blur(): Promise<void>;
-    /** Whether the list option is focused. */
+    /** Whether the action list item is focused. */
     isFocused(): Promise<boolean>;
-    /** Toggles the checked state of the checkbox. */
-    toggle(): Promise<void>;
+}
+
+/** Harness for interacting with a list in tests. */
+declare class MatListHarness extends MatListHarnessBase<typeof MatListItemHarness, MatListItemHarness, ListItemHarnessFilters> {
+    /** The selector for the host element of a `MatList` instance. */
+    static hostSelector: string;
     /**
-     * Puts the list option in a checked state by toggling it if it is currently
-     * unchecked, or doing nothing if it is already checked.
+     * Gets a `HarnessPredicate` that can be used to search for a list with specific attributes.
+     * @param options Options for filtering which list instances are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
      */
-    select(): Promise<void>;
+    static with<T extends MatListHarness>(this: ComponentHarnessConstructor<T>, options?: ListHarnessFilters): HarnessPredicate<T>;
+    _itemHarness: typeof MatListItemHarness;
+}
+/** Harness for interacting with a list item. */
+declare class MatListItemHarness extends MatListItemHarnessBase {
+    /** The selector for the host element of a `MatListItem` instance. */
+    static hostSelector: string;
     /**
-     * Puts the list option in an unchecked state by toggling it if it is currently
-     * checked, or doing nothing if it is already unchecked.
+     * Gets a `HarnessPredicate` that can be used to search for a list item with specific attributes.
+     * @param options Options for filtering which list item instances are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
      */
-    deselect(): Promise<void>;
+    static with<T extends MatListItemHarness>(this: ComponentHarnessConstructor<T>, options?: ListItemHarnessFilters): HarnessPredicate<T>;
 }
 
 /** Harness for interacting with a mat-nav-list in tests. */
-export declare class MatNavListHarness extends MatListHarnessBase<typeof MatNavListItemHarness, MatNavListItemHarness, NavListItemHarnessFilters> {
+declare class MatNavListHarness extends MatListHarnessBase<typeof MatNavListItemHarness, MatNavListItemHarness, NavListItemHarnessFilters> {
     /** The selector for the host element of a `MatNavList` instance. */
     static hostSelector: string;
     /**
@@ -295,9 +259,8 @@ export declare class MatNavListHarness extends MatListHarnessBase<typeof MatNavL
     static with<T extends MatNavListHarness>(this: ComponentHarnessConstructor<T>, options?: NavListHarnessFilters): HarnessPredicate<T>;
     _itemHarness: typeof MatNavListItemHarness;
 }
-
 /** Harness for interacting with a nav-list item. */
-export declare class MatNavListItemHarness extends MatListItemHarnessBase {
+declare class MatNavListItemHarness extends MatListItemHarnessBase {
     /** The selector for the host element of a `MatListItem` instance. */
     static hostSelector: string;
     /**
@@ -322,7 +285,7 @@ export declare class MatNavListItemHarness extends MatListItemHarnessBase {
 }
 
 /** Harness for interacting with a selection-list in tests. */
-export declare class MatSelectionListHarness extends MatListHarnessBase<typeof MatListOptionHarness, MatListOptionHarness, ListOptionHarnessFilters> {
+declare class MatSelectionListHarness extends MatListHarnessBase<typeof MatListOptionHarness, MatListOptionHarness, ListOptionHarnessFilters> {
     /** The selector for the host element of a `MatSelectionList` instance. */
     static hostSelector: string;
     /**
@@ -348,28 +311,43 @@ export declare class MatSelectionListHarness extends MatListHarnessBase<typeof M
     /** Gets all items matching the given list of filters. */
     private _getItems;
 }
-
-/** Harness for interacting with a list subheader. */
-export declare class MatSubheaderHarness extends ComponentHarness {
+/** Harness for interacting with a list option. */
+declare class MatListOptionHarness extends MatListItemHarnessBase {
+    /** The selector for the host element of a `MatListOption` instance. */
     static hostSelector: string;
-    static with(options?: SubheaderHarnessFilters): HarnessPredicate<MatSubheaderHarness>;
-    /** Gets the full text content of the list item (including text from any font icons). */
-    getText(): Promise<string>;
-}
-
-export declare interface NavListHarnessFilters extends BaseHarnessFilters {
-}
-
-export declare interface NavListItemHarnessFilters extends BaseListItemHarnessFilters {
-    href?: string | RegExp | null;
-    activated?: boolean;
-}
-
-export declare interface SelectionListHarnessFilters extends BaseHarnessFilters {
-}
-
-export declare interface SubheaderHarnessFilters extends BaseHarnessFilters {
-    text?: string | RegExp;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a list option with specific
+     * attributes.
+     * @param options Options for filtering which list option instances are considered a match.
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with<T extends MatListOptionHarness>(this: ComponentHarnessConstructor<T>, options?: ListOptionHarnessFilters): HarnessPredicate<T>;
+    private _beforeCheckbox;
+    private _beforeRadio;
+    /** Gets the position of the checkbox relative to the list option content. */
+    getCheckboxPosition(): Promise<MatListOptionTogglePosition>;
+    /** Gets the position of the radio relative to the list option content. */
+    getRadioPosition(): Promise<MatListOptionTogglePosition>;
+    /** Whether the list option is selected. */
+    isSelected(): Promise<boolean>;
+    /** Focuses the list option. */
+    focus(): Promise<void>;
+    /** Blurs the list option. */
+    blur(): Promise<void>;
+    /** Whether the list option is focused. */
+    isFocused(): Promise<boolean>;
+    /** Toggles the checked state of the checkbox. */
+    toggle(): Promise<void>;
+    /**
+     * Puts the list option in a checked state by toggling it if it is currently
+     * unchecked, or doing nothing if it is already checked.
+     */
+    select(): Promise<void>;
+    /**
+     * Puts the list option in an unchecked state by toggling it if it is currently
+     * checked, or doing nothing if it is already unchecked.
+     */
+    deselect(): Promise<void>;
 }
 
-export { }
+export { type ActionListHarnessFilters, type ActionListItemHarnessFilters, type BaseListItemHarnessFilters, type ListHarnessFilters, type ListItemHarnessFilters, type ListOptionHarnessFilters, MatActionListHarness, MatActionListItemHarness, MatListHarness, MatListItemHarness, MatListItemSection, MatListItemType, MatListOptionHarness, MatNavListHarness, MatNavListItemHarness, MatSelectionListHarness, MatSubheaderHarness, type NavListHarnessFilters, type NavListItemHarnessFilters, type SelectionListHarnessFilters, type SubheaderHarnessFilters };