JSDoc: Class: AriaDriver

Constructor

new AriaDriver(optionsopt)

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`url`	string	<optional>	location of a running WebDriver server
`patience`	number	<optional>	number of milliseconds to wait for expected UI events before reporting a timeout error (default: 1000).

Source:

index.js, line 33

See:

https://www.w3.org/TR/wai-aria-practices-1.1/

Extends

external:EventEmitter

Members

(readonly) patience :number

The number of milliseconds to wait for expected UI events before reporting a timeout error. Set during object construction.

Type:

number

Source:

index.js, line 53

Methods

closeDialog()

Close the currently-active dialog

Source:

widgets/dialog.js, line 56

See:

https://www.w3.org/TR/wai-aria-practices-1.1/#dialog_modal

Throws:

When there is no active dialog

get(url)

Navigate the current top-level browsing context to a new location.

Parameters:

Name	Type	Description
`url`	string	the desired location

Source:

index.js, line 71

See:

https://w3c.github.io/webdriver/#navigate-to

openDialog(selector)

Open a dialog.

Parameters:

Name	Type	Description
`selector`	string	a CSS selector describing the element to use in order to open the dialog.

Source:

widgets/dialog.js, line 25

See:

https://w3c.github.io/aria-practices/#dialog_modal

openPopup(selector)

Open an interactive popup element.

Parameters:

Name	Type	Description
`selector`	string	a CSS selector describing the element to use in order to open the popup.

Source:

widgets/popup.js, line 28

See:

Throws:

When the aria-haspopup attribute of the target element is unspecified or invalid
When the number of visible popups does not increase within the "patience" duration

pushButton(selector)

Operate a button. This method waits for "toggle" buttons to change state.

Parameters:

Name	Type	Description
`selector`	string	a CSS selector describing the element to use in order to operate the button.

Source:

widgets/button.js, line 28

Throws:

When the target element does not have an accessible name
When the target element is not a button element and does not bear the button role
When a "toggle" button does not change state within the "patience" duration

quit()

Terminates the browser session. After calling quit, this instance will be invalidated and may no longer be used to issue commands against the browser.

Source:

index.js, line 146

(async) use(selector)

Use the specified element: bring the element into focus and press the "enter" key.

Parameters:

Name	Type	Description
`selector`	string	CSS selector describing an element on the page

Source:

index.js, line 115

Throws:

When the `aria-hidden` attribute of the target element is set to `true`
When the target element is not reported as the document's activeElement following interaction.