@spec add_cookies(t(), [cookie()]) :: :ok

Adds cookies into this Playwright.BrowserContext.

All pages within this context will have these cookies installed. Cookies can be obtained via Playwright.BrowserContext.cookies/1.

Returns

• :ok

Example

:ok = BrowserContext.add_cookies(context, [cookie_1, cookie_2])

Cookie fields

@spec 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 a page is created in the browser context or is navigated.
• Whenever a child frame is attached or navigated in any page in the browser context. 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;

BrowserContext.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.

@spec clear_cookies(t()) :: :ok

Clears Playwright.BrowserContext cookies.

@spec close(t()) :: :ok

Closes the Playwright.BrowserContext. All pages that belong to the Playwright.BrowserContext will be closed.

NOTE:

• The default browser context cannot be closed.

@spec cookies(t(), url() | [url()]) :: [cookie()]

Returns cookies for the Playwright.BrowserContext.

If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned.

Returns

• [cookie()] See add_cookies/2 for cookie field details.

Arguments

Waits for an event to fire (i.e., is blocking) and passes its value into the predicate function.

Returns when the predicate returns a truthy value. Throws an error if the context closes before the event is fired. Returns a Playwright.SDK.Channel.Event.

Arguments

• event: Event name; the same as those passed to Playwright.BrowserContext.on/3
• predicate: Receives the Playwright.SDK.Channel.Event and resolves to a "truthy" value when the waiting should resolve.
• options:
  • predicate: ...
  • timeout: The maximum time to wait in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed via Playwright.BrowserContext.set_default_timeout/2.

Example

event_info = BrowserContext.expect_event(context, :page, fn ->
  BrowserContext.new_page(context)
end)

Executes trigger and waits for a new Playwright.Page to be created within the Playwright.BrowserContext.

If predicate is provided, it passes the Playwright.Page value into the predicate function, wrapped in Playwright.SDK.Channel.Event, and waits for predicate/1 to return a "truthy" value. Throws an error if the context closes before new Playwright.Page is created.

Arguments

• predicate: Receives the Playwright.Page and resolves to truthy value when the waiting should resolve.
• options:
  • predicate: ...
  • timeout: The maximum time to wait in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed via Playwright.BrowserContext.set_default_timeout/2.

@spec expose_binding(t(), String.t(), function(), options()) :: t()

Adds a function called param:name on the window object of every frame in every page in the context.

When called, the function executes param:callback and resolves to the return value of the callback.

The first argument to the callback function includes the following details about the caller:

%{
  context: %Playwright.BrowserContext{},
  frame:   %Playwright.Frame{},
  page:    %Playwright.Page{}
}

See Playwright.Page.expose_binding/4 for a similar, page-scoped version.

@spec expose_function(t(), String.t(), function()) :: t()

Adds a function called param:name on the window object of every frame in every page in the context.

When called, the function executes param:callback and resolves to the return value of the callback.

See Playwright.Page.expose_function/3 for a similar, Page-scoped version.

@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 new_page(t()) :: Playwright.Page.t()

Creates a new Playwright.Page in the context.

If the context is already "owned" by a Playwright.Page (i.e., was created as a side effect of Playwright.Browser.new_page/1), will raise an error because there should be a 1-to-1 mapping in that case.

@spec on(t(), event(), function()) :: :ok

Register a (non-blocking) callback/handler for various types of events.

@spec pages(t()) :: [Playwright.Page.t()]

Returns all open pages in the context.

Returns

• [Page.t()]