@spec click(t(), binary(), options()) :: :ok

Clicks an element matching param: selector, performing the following steps:

1. Find an element matching param: selector. If there is none, wait until a matching element is attached to the DOM.
2. Wait for "actionability (guide)" checks on the matched element, unless option: force option is set. If the element is detached during the checks, the whole action is retried.
3. Scroll the element into view if needed.
4. Use Playwright.Page.Mouse to click the center of the element, or the specified option: position.
5. Wait for initiated navigations to either succeed or fail, unless option: :no_wait_after option is set.

When all steps combined have not finished during the specified option: timeout, /click/3 raises a TimeoutError. Passing zero for option: timeout disables this.

@spec dblclick(t(), binary(), options()) :: :ok

Double clicks an element matching selector.

Performs the following steps:

1. Find an element matching param: selector. If there is none, wait until a matching element is attached to the DOM.
2. Wait for actionability checks on the matched element, unless option: force is set. If the element is detached during the checks, the whole action is retried.
3. Scroll the element into view if needed.
4. Use Page.Mouse to double click in the center of the element, or the specified option: position.
5. 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.

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

@spec dispatch_event(t(), binary(), binary(), evaluation_argument(), options()) :: :ok

Dispatches the param: type event on the param: selector 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:

Frame.dispatch_event(frame, "button#submit", :click)

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

data_transfer = Frame.evaluate_handle(frame, "new DataTransfer()")
Frame.dispatch_event(frame, "#source", :dragstart, { "dataTransfer": data_transfer })

Returns

• :ok

Arguments

@spec eval_on_selector(t(), binary(), binary(), term(), map()) :: term()

Returns the return value of expression.

!!!

@spec evaluate(t(), expression(), any()) :: :ok

Returns the return value of expression. !!!

@spec evaluate_handle(t(), expression(), any()) :: serializable()

Returns the return value of expression as a Playwright.JSHandle. !!!

@spec fill(t(), binary(), 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.Frame.type/4.

Returns

• :ok

Arguments

@spec focus(t(), binary(), options()) :: :ok

Fetches an element with param: selector and focuses it.

If no element matches the selector, waits until a matching element appears in the DOM.

Returns

• :ok

Arguments

@spec get_attribute(t(), binary(), binary(), map()) :: binary() | nil

Returns element attribute value. !!!

@spec get_by_text(t(), binary(), %{optional(:exact) => boolean()}) ::
  Playwright.Locator.t() | nil

Allows locating elements that contain given text.

Arguments

@spec goto(t(), binary(), options()) ::
  Playwright.Response.t() | nil | {:error, term()}

!!!

@spec hover(t(), binary(), options()) :: :ok

Hovers over an element matching param: selector.

Performs the following steps:

1. Find an element matching param: selector. If there is none, wait until a matching element is attached to the DOM.
2. 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.
3. Scroll the element into view if needed.
4. Use Page.Mouse to hover over the center of the element, or the specified option: position.
5. 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

@spec init(
  struct(),
  map()
) :: {atom(), struct()}

Optional callback implementation for Playwright.SDK.ChannelOwner.init/2.

If implemented, the callback will receive:

1. The newly created "channel owner" struct.
2. The :initializer received from the Playwright browser server.

The implementation has the option of "patching" the struct as stored in the catalog, and/or binding event handlers.

Example

def init(%{session: session} = owner, _initializer) do
  Channel.bind(session, {:guid, owner.guid}, :close, fn event ->
    Logger.warning("Closing #{inspect(event.target)}")
  end)

  {:ok, %{owner | version: "1.2.3"}}
end

Returns

• {:ok, struct()}

Arguments

@spec press(t(), binary(), binary(), options()) :: :ok

param: key can specify the intended keyboardEvent.key value or a single character for which to generate the text.

A superset of the param: key values can be found on MDN.

Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

The following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft.

Holding down Shift will type the text that corresponds to the param: key in the upper case.

If param: key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

Shortcuts such as key: "Control+o" or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

Returns

• :ok

Arguments

See Playwright.Frame.query_selector/3.

See Playwright.Frame.query_selector_all/3.

@spec query_selector(t(), binary(), map()) ::
  Playwright.ElementHandle.t() | nil | {:error, :timeout}

Returns the Playwright.ElementHandle pointing to the frame element.

The function finds an element matching the specified selector within the frame. See "working with selectors (guide)" for more details. If no elements match the selector, returns nil.

Returns

• Playwright.ElementHandle.t()
• nil

Arguments

@spec query_selector_all(t(), binary(), map()) :: [Playwright.ElementHandle.t()]

Returns the list of Playwright.ElementHandle pointing to the frame elements.

The method finds all elements matching the specified selector within the frame. See "working with selectors (guide)" for more details.

If no elements match the selector, returns an empty List.

Returns

• [Playwright.ElementHandle.t()]

Arguments

@spec select_option(t(), binary(), any(), options()) :: [binary()]

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

Performs the following steps:

1. Waits for an element matching param: selector
2. Waits for actionability checks
3. Waits until all specified options are present in the <select> element
4. 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

# single selection matching the value
Frame.select_option(frame, "select#colors", "blue")

# single selection matching both the label
Frame.select_option(frame, "select#colors", %{label: "blue"})

# multiple selection
Frame.select_option(frame, "select#colors", %{value: ["red", "green", "blue"]})

Returns

• [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).

@spec set_content(t(), binary(), options()) :: :ok

Returns

• :ok

Arguments

@spec text_content(t(), binary(), map()) :: binary() | nil

Returns Playwright.ElementHandle.text_content/1

Returns

• binary() | nil

Arguments

@spec title(t()) :: binary()

Returns the page title.

Returns

• binary()

@spec wait_for_load_state(t(), binary(), options()) :: t()

Waits for the required load state to be reached.

This returns when the frame reaches a required load state, "load" by default. The navigation must have been committed when this method is called. If the current document has already reached the required state, resolves immediately.

@spec wait_for_selector(t(), binary(), map()) ::
  Playwright.ElementHandle.t() | {:error, Playwright.SDK.Channel.Error.t()}

Returns when element specified by selector satisfies state option.

FIXME: the following is NOT TRUE... Returns nil if waiting for a hidden or detached element.