Specs

all_inner_texts(t()) :: {:ok, [binary()]}

Specs

all_text_contents(t()) :: {:ok, [binary()]}

Specs

check(t(), options()) :: :ok | {:error, Playwright.Runner.Channel.Error.t()}

Checks the (checkmark) element by performing the following steps:

1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
2. Wait for actionability checks on the element, unless force option is set.
3. Scroll the element into view if needed.
4. Use Playwright.Page.Mouse to click in the center of the element.
5. Wait for initiated navigations to either succeed or fail, unless option: no_wait_after is set.
6. Ensure that the element is now checked. If not, this method throws.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing 0 timeout disables this.

Returns

• :ok

Arguments

Specs

click(t(), options_click()) ::
  :ok | {:error, Playwright.Runner.Channel.Error.t()}

Clicks the element by performing the following steps:

1. Wait for actionability checks on the element, unless option: force is set.
2. Scroll the element into view if needed.
3. Use Playwright.Page.Mouse to click in the center of the element, or the specified position.
4. Wait for initiated navigations to either succeed or fail, unless option: no_wait_after is set.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a Playwright.Runner.Channel.Error.t(). Passing 0 timeout disables this.

Returns

• :ok

Arguments

Specs

dblclick(t(), options()) :: :ok

Double clicks the element.

Performs the following steps:

1. Wait for actionability checks on the matched element, unless option: force is set.
2. Scroll the element into view if needed. 3 Use Page.Mouse to double click in the center of the element, or the specified option: position.
3. Wait for initiated navigations to either succeed or fail, unless option: no_wait_after is set. Note that if the first click of the dblclick/3 triggers a navigation event, the call will throw.

If the element is detached from the DOM at any moment during the action, the call throws.

When all steps combined have not finished during the specified option: timeout, throws a TimeoutError. Passing timeout: 0 disables this.

NOTE

dblclick/3 dispatches two click events and a single dblclick event.

Returns

• :ok

Arguments

Specs

dispatch_event(
  t(),
  atom() | binary(),
  Playwright.Frame.evaluation_argument(),
  options()
) :: :ok

Dispatches the param: type event on the element.

Regardless of the visibility state of the element, the event is dispatched.

Under the hood, creates an instance of an event based on the given type, initializes it with the param: event_init properties and dispatches it on the element.

Events are composed, cancelable and bubble by default.

The param: event_init is event-specific. Please refer to the events documentation for the lists of initial properties:

• DragEvent
• FocusEvent
• KeyboardEvent
• MouseEvent
• PointerEvent
• TouchEvent
• Event

Example

Dispatch a 'click' event on the element. This is equivalent to calling Playwright.ElementHandle.click/2:

Locator.dispatch_event(locator, :click)

Specify a Playwright.JSHandle as the property value to be passed into the event:

data_transfer = Page.evaluate_handle(page, "new DataTransfer()")
Locator.dispatch_event(locator, :dragstart, { "dataTransfer": data_transfer })

Returns

• :ok

Arguments

Specs

element_handle(t(), options()) ::
  {:ok, Playwright.ElementHandle.t()}
  | {:error, Playwright.Runner.Channel.Error.t()}

Resolves the given Playwright.Locator to the first matching DOM element.

If no elements matching the query are visible, waits for them up to a given timeout. If multiple elements match the selector, throws.

Returns

• {:ok, Playwright.ElementHandle.t()}
• {:error, Playwright.Runner.Channel.Error.t()}

Arguments

Specs

element_handles(t()) :: {:ok, [Playwright.ElementHandle.t()]}

Resolves given locator to all matching DOM elements.

Returns

• [Playwright.ElementHandle.t()]

Specs

evaluate(t(), binary(), Playwright.ElementHandle.t() | nil, options()) ::
  {:ok, serializable()}

...

Specs

evaluate_all(t(), binary(), Playwright.ElementHandle.t() | nil) ::
  {:ok, [serializable()]}

...

Specs

evaluate_handle(t(), binary(), any(), options()) ::
  {:ok, Playwright.JSHandle.t()} | {:error, Playwright.Runner.Channel.Error.t()}

Returns the result of param: expression as a Playwright.JSHandle.

Passes the handle as the first argument to param: expression.

The only difference between Playwright.Locator.evaluate/4 and Playwright.Locator.evaluate_handle/3 is that evaluate_handle returns JSHandle.

See Playwright.Page.evaluate_handle for more details.

Returns

• {:ok, Playwright.JSHandle.t()}
• {:error, Playwright.Runner.Channel.Error.t()}

Arguments

Specs

fill(t(), binary(), options()) :: :ok

Fills a form field or contenteditable element with text.

Waits for an element matching param: selector, waits for "actionability checks", focuses the element, fills it and triggers an input event after filling.

If the target element is not an <input>, <textarea> or contenteditable element, this function raises an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.

NOTE

• Pass an empty string to clear the input field.
• To send fine-grained keyboard events, use Playwright.Locator.type/3.

Returns

• :ok

Arguments

Specs

focus(t(), options()) :: :ok

Calls focus on the element.

Returns

• :ok

Arguments

Specs

get_attribute(t(), binary(), options()) :: {:ok, binary() | nil}

Specs

hover(t(), options()) :: :ok

Hovers over the element.

Performs the following steps:

1. Wait for actionability checks on the matched element, unless option: force option is set. If the element is detached during the checks, the whole action is retried.
2. Scroll the element into view if needed.
3. Use Page.Mouse to hover over the center of the element, or the specified option: position.
4. Wait for initiated navigations to either succeed or fail, unless option: no_wait_after is set.

When all steps combined have not finished during the specified option: timeout, throws a TimeoutError. Passing 0 timeout disables this.

Returns

• :ok

Arguments

Specs

inner_html(t(), options()) :: {:ok, binary()}

Specs

inner_text(t(), options()) :: {:ok, binary()}

Specs

input_value(t(), options()) :: {:ok, binary()}

Specs

is_checked(t(), options()) ::
  :ok | {:error, Playwright.Runner.Channel.Error.t()}

Specs

is_disabled(t(), options()) ::
  :ok | {:error, Playwright.Runner.Channel.Error.t()}

Specs

is_editable(t(), options()) ::
  :ok | {:error, Playwright.Runner.Channel.Error.t()}

Specs

is_enabled(t(), options()) ::
  :ok | {:error, Playwright.Runner.Channel.Error.t()}

Specs

is_hidden(t(), options()) :: :ok | {:error, Playwright.Runner.Channel.Error.t()}

Specs

is_visible(t(), options()) ::
  :ok | {:error, Playwright.Runner.Channel.Error.t()}

Specs

locator(t(), binary()) :: t()

Specs

new(Playwright.Frame.t() | Playwright.Page.t(), selector()) :: t()

Returns a %Playwright.Locator{}.

Arguments

| frame | param | Frame.t() | Page.t() | | | selector | param | binary() | A Playwright selector. |

Specs

select_option(t(), any(), options()) :: {:ok, [binary()]}

Selects one or more options from a <select> element.

Performs the following steps:

1. Waits for actionability checks
2. Waits until all specified options are present in the <select> element
3. Selects those options

If the target element is not a <select> element, raises an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.

Returns the list of option values that have been successfully selected.

Triggers a change and input event once all the provided options have been selected.

Example

locator = Page.locator(page, "select#colors")

# single selection matching the value
Locator.select_option(locator, "blue")

# single selection matching both the label
Locator.select_option(locator, %{label: "blue"})

# multiple selection
Locator.select_option(locator, %{value: ["red", "green", "blue"]})

Returns

• {:ok, [binary()]}

Arguments

On values

If the <select> has the multiple attribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected.

String values are equivalent to %{value: "string"}.

Option is considered matching if all specified properties match.

• value <binary> Matches by option.value. (optional).
• label <binary> Matches by option.label. (optional).
• index <number> Matches by the index. (optional).

Specs

text_content(t(), options()) ::
  :ok | {:error, Playwright.Runner.Channel.Error.t()}

Specs

uncheck(t(), options()) :: :ok | {:error, Playwright.Runner.Channel.Error.t()}

Unchecks the (checkmark) element by performing the following steps:

1. Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
2. Wait for actionability checks on the element, unless force option is set.
3. Scroll the element into view if needed.
4. Use Playwright.Page.Mouse to click in the center of the element.
5. Wait for initiated navigations to either succeed or fail, unless option: no_wait_after is set.
6. Ensure that the element is now checked. If not, this method throws.

If the element is detached from the DOM at any moment during the action, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing 0 timeout disables this.

Returns

• :ok

Arguments

Specs

wait_for(t(), options()) :: :ok | {:error, Playwright.Runner.Channel.Error.t()}

Returns when element specified by locator satisfies option: state.

If target element already satisfies the condition, the method returns immediately. Otherwise, waits for up to option: timeout milliseconds until the condition is met.