element.md

selenidejs › Element

Class: Element

Hierarchy

• Entity

  ↳ Element

Implements

• Assertable
• Matchable
• Assertable
• Matchable

Index

Constructors

• constructor

Properties

• configuration
• locator
• wait

Accessors

• followingSibling
• parent
• shadow

Methods

• all
• clear
• click
• contextClick
• doubleClick
• element
• executeScript
• get
• getWebElement
• hover
• matching
• perform
• pressEnter
• pressEscape
• pressTab
• setValue
• should
• toString
• type
• waitUntil
• with

Constructors

constructor

+ new Element(locator: Locator‹Promise‹WebElement››, configuration: Configuration): Element

Overrides Entity.constructor

Defined in lib/element.ts:33

Parameters:

Name	Type
locator	Locator‹Promise‹WebElement››
configuration	Configuration

Returns: Element

Properties

configuration

• configuration: Configuration

Inherited from Entity.configuration

Defined in lib/entity.ts:52

---

locator

• locator: Locator‹Promise‹WebElement››

Defined in lib/element.ts:33

---

Protected wait

• wait: Wait‹this›

Inherited from Entity.wait

Defined in lib/entity.ts:53

Accessors

followingSibling

• get followingSibling(): Element

Defined in lib/element.ts:92

Returns: Element

---

parent

• get parent(): Element

Defined in lib/element.ts:88

Returns: Element

---

shadow

• get shadow(): Shadow

Defined in lib/element.ts:96

Returns: Shadow

Methods

all

▸ all(located: string | By | object, customized?: Partial‹Configuration›): Collection

Defined in lib/element.ts:71

Parameters:

Name	Type
located	string | By | object
customized?	Partial‹Configuration›

Returns: Collection

---

clear

▸ clear(): Promise‹this›

Defined in lib/element.ts:117

Returns: Promise‹this›

---

click

▸ click(): Promise‹this›

Defined in lib/element.ts:110

Returns: Promise‹this›

---

contextClick

▸ contextClick(): Promise‹this›

Defined in lib/element.ts:172

Returns: Promise‹this›

---

doubleClick

▸ doubleClick(): Promise‹this›

Defined in lib/element.ts:148

Returns: Promise‹this›

---

element

▸ element(located: string | By‹› | object, customized?: Partial‹Configuration›): Element

Defined in lib/element.ts:54

Parameters:

Name	Type
located	string | By‹› | object
customized?	Partial‹Configuration›

Returns: Element

---

executeScript

▸ executeScript(script: string | function, ...args: any[]): Promise‹unknown›

Defined in lib/element.ts:101

Parameters:

Name	Type
script	string | function
...args	any[]

Returns: Promise‹unknown›

---

get

▸ get<R>(query: Lambda‹this, R›): Promise‹R›

Inherited from Entity.get

Defined in lib/entity.ts:103

Type parameters:

▪ R

Parameters:

Name	Type
query	Lambda‹this, R›

Returns: Promise‹R›

---

getWebElement

▸ getWebElement(): Promise‹WebElement›

Defined in lib/element.ts:44

Returns: Promise‹WebElement›

---

hover

▸ hover(): Promise‹this›

Defined in lib/element.ts:160

Returns: Promise‹this›

---

matching

▸ matching(...conditions: Condition‹this›[]): Promise‹boolean›

Inherited from Entity.matching

Defined in lib/entity.ts:88

Parameters:

Name	Type
...conditions	Condition‹this›[]

Returns: Promise‹boolean›

---

perform

▸ perform(command: Lambda‹this, void›): Promise‹this›

Inherited from Entity.perform

Defined in lib/entity.ts:94

Parameters:

Name	Type
command	Lambda‹this, void›

Returns: Promise‹this›

---

pressEnter

▸ pressEnter(): Promise‹this›

Defined in lib/element.ts:191

Returns: Promise‹this›

---

pressEscape

▸ pressEscape(): Promise‹this›

Defined in lib/element.ts:195

Returns: Promise‹this›

---

pressTab

▸ pressTab(): Promise‹this›

Defined in lib/element.ts:199

Returns: Promise‹this›

---

setValue

▸ setValue(value: string | number): Promise‹this›

Defined in lib/element.ts:124

Parameters:

Name	Type
value	string | number

Returns: Promise‹this›

---

should

▸ should(...conditions: Condition‹this›[]): Promise‹this›

Inherited from Entity.should

Defined in lib/entity.ts:77

Parameters:

Name	Type
...conditions	Condition‹this›[]

Returns: Promise‹this›

---

toString

▸ toString(): string

Defined in lib/element.ts:40

Returns: string

---

type

▸ type(keys: string | number): Promise‹this›

Defined in lib/element.ts:138

Parameters:

Name	Type
keys	string | number

Returns: Promise‹this›

---

waitUntil

▸ waitUntil(...conditions: Condition‹this›[]): Promise‹boolean›

Implementation of Matchable

Inherited from Entity.waitUntil

Defined in lib/entity.ts:84

Parameters:

Name	Type
...conditions	Condition‹this›[]

Returns: Promise‹boolean›

---

with

▸ with(customConfig: Partial‹Configuration›): Element

Defined in lib/element.ts:50

Parameters:

Name	Type
customConfig	Partial‹Configuration›

Returns: Element