Wallaby.Element (wallaby v0.28.0) View Source

Defines an Element Struct and interactions with Elements.

Typically these functions are used in conjunction with a find:

page
|> find(Query.css(".some-element"), fn(element) -> Element.click(element) end)

These functions can be used to create new actions specific to your application:

def create_todo(todo_field, todo_text) do
  todo_field
  |> Element.click()
  |> Element.fill_in(with: todo_text)
  |> Element.send_keys([:enter])
end

Retrying

Unlike Browser the actions in Element do not retry if the element becomes stale. Instead an exception will be raised.

Link to this section Summary

Types

attr()

keys_to_send()

t()

value()

Functions

attr(element, name)

Gets the value of the element's attribute.

clear(element)

Clears any value set in the element.

click(element, retry_count \\ 0)

Clicks the element.

fill_in(element, list)

Fills in the element with the specified value.

hover(element)

Hovers on the element.

location(element)

Returns a tuple {x, y} with the coordinates of the left-top corner of given element.

selected?(element)

Returns a boolean based on whether or not the element is selected.

send_keys(element, text)

Sends keys to the element.

set_value(element, value)

Sets the value of the element.

size(element)

Returns a tuple {width, height} with the size of the given element.

tap(element)

Taps the element.

text(element)

Gets the element's text value.

touch_down(element, x_offset \\ 0, y_offset \\ 0)

Touches and holds the element on its top-left corner plus an optional offset.

touch_scroll(element, x_offset, y_offset)

Scroll on the screen from the given element by the given offset using touch events.

value(element)

Matches the Element's value with the provided value.

visible?(element)

Returns a boolean based on whether or not the element is visible.

Link to this section Types

attr()

Specs

attr() :: String.t()

keys_to_send()

Specs

keys_to_send() :: String.t() | [atom() | String.t()]

t()

Specs

t() :: %Wallaby.Element{
  driver: module(),
  id: String.t(),
  parent: term(),
  screenshots: list(),
  session_url: String.t(),
  url: String.t()
}

value()

Specs

value() :: String.t() | number() | :selected | :unselected

Link to this section Functions

attr(element, name)

Specs

attr(t(), attr()) :: String.t() | nil

Gets the value of the element's attribute.

clear(element)

Specs

clear(t()) :: t()

Clears any value set in the element.

click(element, retry_count \\ 0)

Clicks the element.

fill_in(element, list)

Specs

fill_in(t(), [{:with, String.t() | number()}]) :: t()

Fills in the element with the specified value.

hover(element)

Specs

hover(t()) :: t()

Hovers on the element.

location(element)

Specs

location(t()) :: t()

Returns a tuple {x, y} with the coordinates of the left-top corner of given element.

selected?(element)

Specs

selected?(t()) :: boolean()

Returns a boolean based on whether or not the element is selected.

Note

This only really makes sense for options, checkboxes, and radio buttons. Everything else will simply return false because they have no notion of "selected".

send_keys(element, text)

Specs

send_keys(t(), keys_to_send()) :: t()

Sends keys to the element.

set_value(element, value)

Specs

set_value(t(), value()) :: t()

Sets the value of the element.

size(element)

Specs

size(t()) :: t()

Returns a tuple {width, height} with the size of the given element.

tap(element)

Specs

tap(t()) :: t()

Taps the element.

text(element)

Specs

text(t()) :: String.t()

Gets the element's text value.

If the element is not visible, the return value will be "".

touch_down(element, x_offset \\ 0, y_offset \\ 0)

Specs

touch_down(t(), integer(), integer()) :: t()

Touches and holds the element on its top-left corner plus an optional offset.

touch_scroll(element, x_offset, y_offset)

Specs

touch_scroll(t(), integer(), integer()) :: t()

Scroll on the screen from the given element by the given offset using touch events.

value(element)

Specs

value(t()) :: String.t()

Matches the Element's value with the provided value.

visible?(element)

Specs

visible?(t()) :: boolean()

Returns a boolean based on whether or not the element is visible.