@angular/cdk/testing

TestElement

interface

This acts as a common interface for DOM elements across both unit and e2e tests. It is the interface through which the ComponentHarness interacts with the component's DOM.

API

  
    interface TestElement {
}

blur

Promise<void>

Blur the element.

@returnsPromise<void>

clear

Promise<void>

Clear the element's input (for input and textarea elements only).

@returnsPromise<void>

click

Promise<void>

Click the element at the default location for the current environment. If you need to guarantee the element is clicked at a specific location, consider using click('center') or click(x, y) instead.

@parammodifiersModifierKeys | undefined

@returnsPromise<void>

click

Promise<void>

Click the element at the element's center.

@paramlocation"center"

@parammodifiersModifierKeys | undefined

@returnsPromise<void>

click

Promise<void>

Click the element at the specified coordinates relative to the top-left of the element.

@paramrelativeXnumber

Coordinate within the element, along the X-axis at which to click.

@paramrelativeYnumber

Coordinate within the element, along the Y-axis at which to click.

@parammodifiersModifierKeys | undefined

Modifier keys held while clicking

@returnsPromise<void>

rightClick

Promise<void>

Right clicks on the element at the specified coordinates relative to the top-left of it.

@paramrelativeXnumber

Coordinate within the element, along the X-axis at which to click.

@paramrelativeYnumber

Coordinate within the element, along the Y-axis at which to click.

@parammodifiersModifierKeys | undefined

Modifier keys held while clicking

@returnsPromise<void>

focus

Promise<void>

Focus the element.

@returnsPromise<void>

getCssValue

Promise<string>

Get the computed value of the given CSS property for the element.

@parampropertystring

@returnsPromise<string>

hover

Promise<void>

Hovers the mouse over the element.

@returnsPromise<void>

mouseAway

Promise<void>

Moves the mouse away from the element.

@returnsPromise<void>

sendKeys

Promise<void>

Sends the given string to the input as a series of key presses. Also fires input events and attempts to add the string to the Element's value. Note that some environments cannot reproduce native browser behavior for keyboard shortcuts such as Tab, Ctrl + A, etc.

@paramkeys(string | TestKey)[]

@returnsPromise<void>

sendKeys

Promise<void>

Sends the given string to the input as a series of key presses. Also fires input events and attempts to add the string to the Element's value.

@parammodifiersModifierKeys

@paramkeys(string | TestKey)[]

@returnsPromise<void>

text

Promise<string>

Gets the text from the element.

@paramoptionsTextOptions | undefined

Options that affect what text is included.

@returnsPromise<string>

setContenteditableValue

Promise<void>

Sets the value of a contenteditable element.

@paramvaluestring

Value to be set on the element.

@returnsPromise<void>

getAttribute

Promise<string | null>

Gets the value for the given attribute from the element.

@paramnamestring

@returnsPromise<string | null>

hasClass

Promise<boolean>

Checks whether the element has the given class.

@paramnamestring

@returnsPromise<boolean>

getDimensions

Promise<ElementDimensions>

Gets the dimensions of the element.

@returnsPromise<ElementDimensions>

getProperty

Promise<T>

Gets the value of a property of an element.

@paramnamestring

@returnsPromise<T>

matchesSelector

Promise<boolean>

Checks whether this element matches the given selector.

@paramselectorstring

@returnsPromise<boolean>

isFocused

Promise<boolean>

Checks whether the element is focused.

@returnsPromise<boolean>

setInputValue

Promise<void>

Sets the value of a property of an input.

@paramvaluestring

@returnsPromise<void>

selectOptions

Promise<void>

Selects the options at the specified indexes inside of a native select element.

@paramoptionIndexesnumber[]

@returnsPromise<void>

dispatchEvent

Promise<void>

Dispatches an event with a particular name.

@paramnamestring

Name of the event to be dispatched.

@paramdataRecord<string, EventData> | undefined

@returnsPromise<void>