@ngx-playwright/test
Version:
133 lines • 4.5 kB
TypeScript
/**
* @typedef {[ModifierKeys?] | ['center', ModifierKeys?] | [number, number, ModifierKeys?]} ClickParameters
*/
/**
*
* @param {ElementHandle<unknown> | Locator} handleOrLocator
* @returns {handleOrLocator is Locator}
*/
export function isLocator(handleOrLocator: ElementHandle<unknown> | Locator): handleOrLocator is Locator;
/**
* `TestElement` implementation backed by playwright's `ElementHandle`
*
* @internal
* @implements TestElement
*/
export class PlaywrightElement implements TestElement {
/**
* @param {import('./environment.js').PlaywrightHarnessEnvironment} environment
* @param {ElementHandle<HTMLElement | SVGElement> | Locator} handleOrLocator
* @param {() => Promise<void>} whenStable
*/
constructor(environment: import("./environment.js").PlaywrightHarnessEnvironment, handleOrLocator: ElementHandle<HTMLElement | SVGElement> | Locator, whenStable: () => Promise<void>);
/**
* @returns {Promise<void>}
*/
blur(): Promise<void>;
/**
* @returns {Promise<void>}
*/
clear(): Promise<void>;
/**
* @param {ClickParameters} args
* @returns {Promise<void>}
*/
click(...args: ClickParameters): Promise<void>;
/**
* @param {ClickParameters} args
* @returns {Promise<void>}
*/
rightClick(...args: ClickParameters): Promise<void>;
/**
* @param {string} name
* @param {Record<string, EventData>=} data
* @returns {Promise<void>}
*/
dispatchEvent(name: string, data?: Record<string, EventData> | undefined): Promise<void>;
/**
* @returns {Promise<void>}
*/
focus(): Promise<void>;
/**
* @param {string} property
* @returns {Promise<string>}
*/
getCssValue(property: string): Promise<string>;
/**
* @returns {Promise<void>}
*/
hover(): Promise<void>;
/**
* @returns {Promise<void>}
*/
mouseAway(): Promise<void>;
/**
*
* @param {...number} optionIndexes
* @returns {Promise<void>}
*/
selectOptions(...optionIndexes: number[]): Promise<void>;
/**
*
* @param {(string | TestKey | AngularTestKey)[] | [ModifierKeys, ...(string | TestKey | AngularTestKey)[]]} input
* @returns {Promise<void>}
*/
sendKeys(...input: (string | TestKey | AngularTestKey)[] | [ModifierKeys, ...(string | TestKey | AngularTestKey)[]]): Promise<void>;
/**
* @param {string} value
* @returns {Promise<void>}
*/
setInputValue(value: string): Promise<void>;
/**
* @param {TextOptions=} options
* @returns {Promise<string>}
*/
text(options?: TextOptions | undefined): Promise<string>;
/**
* @param {string} value
* @returns {Promise<void>}
*/
setContenteditableValue(value: string): Promise<void>;
/**
* @param {string} name
* @returns {Promise<string | null>}
*/
getAttribute(name: string): Promise<string | null>;
/**
* @param {string} name
* @returns {Promise<boolean>}
*/
hasClass(name: string): Promise<boolean>;
/**
* @returns {Promise<ElementDimensions>}
*/
getDimensions(): Promise<ElementDimensions>;
/**
* @param {string} name
* @returns {Promise<any>}
*/
getProperty(name: string): Promise<any>;
/**
* @param {string} selector
* @returns {Promise<boolean>}
*/
matchesSelector(selector: string): Promise<boolean>;
/**
* @returns {Promise<boolean>}
*/
isFocused(): Promise<boolean>;
#private;
}
export type ClickParameters = [ModifierKeys?] | ["center", ModifierKeys?] | [number, number, ModifierKeys?];
export type ElementDimensions = import("@ngx-playwright/harness").ElementDimensions;
export type EventData = import("@ngx-playwright/harness").EventData;
export type ModifierKeys = import("@ngx-playwright/harness").ModifierKeys;
export type TestElement = import("@ngx-playwright/harness").TestElement;
export type TextOptions = import("@ngx-playwright/harness").TextOptions;
export type ElementHandle<T = Node> = import("@playwright/test").ElementHandle<T>;
export type Locator = import("@playwright/test").Locator;
export type Page = import("@playwright/test").Page;
export type _AngularTestKey = import("@angular/cdk/testing").TestKey;
export type AngularTestKey = boolean extends _AngularTestKey ? never : _AngularTestKey;
import { TestKey } from "@ngx-playwright/harness";
//# sourceMappingURL=../../src/harness/element.d.ts.map