Specs

add_init_script(t(), binary() | map()) :: :ok

Adds a script to be evaluated before other scripts.

The script is evaluated in the following scenarios:

• Whenever the page is navigated.
• Whenever a child frame is attached or navigated. In this case, the script is evaluated in the context of the newly attached frame.

The script is evaluated after the document is created but before any of its scripts are run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.

Returns

• :ok

Arguments

Example

Overriding Math.random before the page loads:

# preload.js
Math.random = () => 42;

Page.add_init_script(context, %{path: "preload.js"})

Notes

While the official Node.js Playwright implementation supports an optional param: arg for this function, the official Python implementation does not. This implementation matches the Python for now.

The order of evaluation of multiple scripts installed via Playwright.BrowserContext.add_init_script/2 and Playwright.Page.add_init_script/2 is not defined.

Specs

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

Specs

close(t(), options()) :: :ok

Closes the Page.

If the Page has an "owned context" (1-to-1 co-dependency with a Playwright.BrowserContext), that context is closed as well.

If option: run_before_unload is false, does not run any unload handlers and waits for the page to be closed. If option: run_before_unload is true the function will run unload handlers, but will not wait for the page to close. By default, Playwright.Page.close/1 does not run :beforeunload handlers.

Returns

• :ok

Arguments

NOTE

if option: run_before_unload is passed as true, a :beforeunload dialog might be summoned and should be handled manually via Playwright.Page.on/3.

Specs

context(t()) :: Playwright.BrowserContext.t()

Get the Playwright.BrowserContext that the page belongs to.

Specs

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

A shortcut for the main frame's Playwright.Frame.dblclick/3.

Specs

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

A shortcut for the main frame's Playwright.Frame.dispatch_event/5.

Specs

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

Specs

evaluate(t(), expression(), any()) :: serializable()

Specs

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

Specs

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

Specs

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

A shortcut for the main frame's Playwright.Frame.focus/3.

Specs

frames(t()) :: [Playwright.Frame.t()]

Specs

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

Specs

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

A shortcut for the main frame's Playwright.Frame.hover/2.

Specs

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

Optional callback implementation for Playwright.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.warn("Closing #{inspect(event.target)}")
  end)

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

Returns

• {:ok, struct()}

Arguments

Specs

locator(t(), selector()) :: Playwright.Locator.t()

Specs

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

See Playwright.Page.query_selector/3.

See Playwright.Page.query_selector_all/3.

Specs

query_selector(t(), selector(), options()) ::
  Playwright.ElementHandle.t() | nil | {:error, :timeout}

Specs

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

Specs

reload(t(), options()) :: Playwright.Response.t() | nil

Reloads the current page.

Reloads in the same way as if the user had triggered a browser refresh.

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

Returns

• Playwright.Response.t() | nil

Arguments

On Wait Events

• domcontentloaded - consider operation to be finished when the DOMContentLoaded event is fired.
• load - consider operation to be finished when the load event is fired.
• networkidle - consider operation to be finished when there are no network connections for at least 500 ms.
• commit - consider operation to be finished when network response is received and the document started loading.

Specs

route(t(), binary(), function(), map()) :: :ok

Specs

screenshot(t(), options()) :: binary()

Specs

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

A shortcut for the main frame's Playwright.Frame.select_option/4.

Specs

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

Specs

set_viewport_size(t(), dimensions()) :: :ok

Specs

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

Specs

title(t()) :: binary()

Specs

url(t()) :: binary()

Specs

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

Specs

wait_for_selector(t(), binary(), map()) :: Playwright.ElementHandle.t() | nil