@vibe/testkit/dist/components/List.d.ts

Vibe e2e testing toolkit

import { Page, Locator } from "@playwright/test";
import { ListItem } from "./ListItem";
import { BaseElement } from "./BaseElement";
/**
 * Class representing a List element.
 * Extends the BaseElement class.
 */
export declare class List extends BaseElement {
    /**
     * Create a List element.
     * @param {Page} page - The Playwright page object.
     * @param {Locator} locator - The locator for the List element.
     * @param {string} elementReportName - The name for reporting purposes.
     */
    constructor(page: Page, locator: Locator, elementReportName: string);
    /**
     * Get a list item by its name.
     * @param {string} itemName - The name of the item to retrieve.
     * @returns {Promise<ListItem>} The list item with the specified name.
     */
    getItemByName(itemName: string): Promise<ListItem>;
    /**
     * Get a list item by its index.
     * @param {number} index - The index of the item to retrieve.
     * @returns {Promise<ListItem>} The list item with the specified index.
     */
    getItemByIndex(index: number): Promise<ListItem>;
    /**
     * Click a list item by its name.
     * @param {string} itemName - The name of the item to click.
     * @returns {Promise<void>}
     */
    selectItem(itemName: string): Promise<void>;
    /**
     * Check if a list item is disabled.
     * @param {string} itemName - The name of the item to check.
     * @returns {Promise<boolean>} True if the item is disabled, false otherwise.
     */
    isItemDisabled(itemName: string): Promise<boolean>;
    /**
     * Get the text of a list item by its index.
     * @param {number} index - The index of the item to retrieve.
     * @returns {Promise<string>} The text of the list item with the specified index.
     */
    getItemTextByIndex(index: number): Promise<string>;
    /**
     * Click a list item by its index.
     * @param {number} index - The index of the item to click.
     * @returns {Promise<void>}
     */
    clickItemByIndex(index: number): Promise<void>;
}
//# sourceMappingURL=List.d.ts.map