Playwright.BrowserType (Playwright v1.65.0-rc.3)

Copy Markdown View Source

BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:

# Or Playwright.firefox/1 or Playwright.webkit/1.
browser = BrowserType.launch!(Playwright.chromium(playwright))
page = Browser.new_page!(browser)
Page.goto!(page, "https://example.com")
# other actions...
Browser.close!(browser)

Since Playwright 1.8.

The examples alias the modules they use (alias Playwright.{Locator, Page}).

Summary

Types

Options of connect/3, see its docs.

Options of launch/2, see its docs.

t()

A BrowserType handle. Compare handles with ==, their fields are internal.

Functions

This method attaches Playwright to an existing browser instance created via BrowserType.launchServer in Node.js.

Like connect/3, but returns the value and raises on error.

This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.

Like connect_over_cdp/3, but returns the value and raises on error.

A path where Playwright expects to find a bundled browser executable.

Returns the browser instance.

Like launch/2, but returns the value and raises on error.

Returns the persistent browser context instance.

Returns browser name. For example: 'chromium', 'webkit' or 'firefox'.

Types

connect_options()

@type connect_options() ::
  [
    expose_network: String.t(),
    headers: %{optional(String.t()) => String.t()},
    slow_mo: number(),
    timeout: number() | :infinity
  ]
  | %{
      optional(:expose_network) => String.t(),
      optional(:headers) => %{optional(String.t()) => String.t()},
      optional(:slow_mo) => number(),
      optional(:timeout) => number() | :infinity
    }

Options of connect/3, see its docs.

connect_over_cdp_options()

@type connect_over_cdp_options() ::
  [
    artifacts_dir: String.t(),
    endpoint_url: String.t(),
    headers: %{optional(String.t()) => String.t()},
    is_local: boolean(),
    no_defaults: boolean(),
    slow_mo: number(),
    timeout: number() | :infinity
  ]
  | %{
      optional(:artifacts_dir) => String.t(),
      optional(:endpoint_url) => String.t(),
      optional(:headers) => %{optional(String.t()) => String.t()},
      optional(:is_local) => boolean(),
      optional(:no_defaults) => boolean(),
      optional(:slow_mo) => number(),
      optional(:timeout) => number() | :infinity
    }

Options of connect_over_cdp/3, see its docs.

launch_options()

@type launch_options() ::
  [
    args: [String.t()],
    artifacts_dir: String.t(),
    channel: String.t(),
    chromium_sandbox: boolean(),
    downloads_path: String.t(),
    env: %{optional(String.t()) => String.t() | nil},
    executable_path: String.t(),
    firefox_user_prefs: %{
      optional(String.t()) => String.t() | number() | boolean()
    },
    handle_sighup: boolean(),
    handle_sigint: boolean(),
    handle_sigterm: boolean(),
    headless: boolean(),
    ignore_default_args: boolean() | [String.t()],
    logger: %{
      isEnabled: (String.t(), String.t() -> boolean()),
      log: (String.t(),
            String.t(),
            String.t()
            | Exception.t(),
            [map()],
            %{optional(:color) => String.t()} ->
              term())
    },
    proxy: %{
      :server => String.t(),
      optional(:bypass) => String.t(),
      optional(:username) => String.t(),
      optional(:password) => String.t()
    },
    slow_mo: number(),
    timeout: number() | :infinity,
    traces_dir: String.t()
  ]
  | %{
      optional(:args) => [String.t()],
      optional(:artifacts_dir) => String.t(),
      optional(:channel) => String.t(),
      optional(:chromium_sandbox) => boolean(),
      optional(:downloads_path) => String.t(),
      optional(:env) => %{optional(String.t()) => String.t() | nil},
      optional(:executable_path) => String.t(),
      optional(:firefox_user_prefs) => %{
        optional(String.t()) => String.t() | number() | boolean()
      },
      optional(:handle_sighup) => boolean(),
      optional(:handle_sigint) => boolean(),
      optional(:handle_sigterm) => boolean(),
      optional(:headless) => boolean(),
      optional(:ignore_default_args) => boolean() | [String.t()],
      optional(:logger) => %{
        isEnabled: (String.t(), String.t() -> boolean()),
        log: (String.t(),
              String.t(),
              String.t()
              | Exception.t(),
              [map()],
              %{optional(:color) => String.t()} ->
                term())
      },
      optional(:proxy) => %{
        :server => String.t(),
        optional(:bypass) => String.t(),
        optional(:username) => String.t(),
        optional(:password) => String.t()
      },
      optional(:slow_mo) => number(),
      optional(:timeout) => number() | :infinity,
      optional(:traces_dir) => String.t()
    }

Options of launch/2, see its docs.

launch_persistent_context_options()

@type launch_persistent_context_options() ::
  [
    accept_downloads: boolean(),
    args: [String.t()],
    artifacts_dir: String.t(),
    base_url: String.t(),
    bypass_csp: boolean(),
    channel: String.t(),
    chromium_sandbox: boolean(),
    client_certificates: [
      %{
        :origin => String.t(),
        optional(:certPath) => String.t(),
        optional(:cert) => binary(),
        optional(:keyPath) => String.t(),
        optional(:key) => binary(),
        optional(:pfxPath) => String.t(),
        optional(:pfx) => binary(),
        optional(:passphrase) => String.t()
      }
    ],
    color_scheme: :null | :light | :dark | :no_preference,
    contrast: :null | :no_preference | :more,
    device_scale_factor: number(),
    downloads_path: String.t(),
    env: %{optional(String.t()) => String.t() | nil},
    executable_path: String.t(),
    extra_http_headers: %{optional(String.t()) => String.t()},
    firefox_user_prefs: %{
      optional(String.t()) => String.t() | number() | boolean()
    },
    forced_colors: :null | :active | :none,
    geolocation: %{
      :latitude => number(),
      :longitude => number(),
      optional(:accuracy) => number()
    },
    handle_sighup: boolean(),
    handle_sigint: boolean(),
    handle_sigterm: boolean(),
    has_touch: boolean(),
    headless: boolean(),
    http_credentials:
      %{
        :username => String.t(),
        :password => String.t(),
        optional(:origin) => String.t(),
        optional(:send) => String.t()
      }
      | [
          %{
            :username => String.t(),
            :password => String.t(),
            optional(:origin) => String.t(),
            optional(:send) => String.t()
          }
        ],
    ignore_default_args: boolean() | [String.t()],
    ignore_https_errors: boolean(),
    is_mobile: boolean(),
    java_script_enabled: boolean(),
    locale: String.t(),
    logger: %{
      isEnabled: (String.t(), String.t() -> boolean()),
      log: (String.t(),
            String.t(),
            String.t()
            | Exception.t(),
            [map()],
            %{optional(:color) => String.t()} ->
              term())
    },
    offline: boolean(),
    permissions: [String.t()],
    proxy: %{
      :server => String.t(),
      optional(:bypass) => String.t(),
      optional(:username) => String.t(),
      optional(:password) => String.t()
    },
    record_har: %{
      optional(:omitContent) => boolean(),
      optional(:content) => String.t(),
      :path => String.t(),
      optional(:mode) => String.t(),
      optional(:urlFilter) => String.t() | Regex.t() | Playwright.RegExp.t()
    },
    record_video: %{
      optional(:dir) => String.t(),
      optional(:size) => %{width: integer(), height: integer()},
      optional(:fps) => integer(),
      optional(:showActions) => %{
        optional(:duration) => number(),
        optional(:position) => String.t(),
        optional(:fontSize) => integer(),
        optional(:cursor) => String.t(),
        optional(:style) => %{
          optional(:point) => String.t(),
          optional(:highlight) => String.t(),
          optional(:title) => String.t()
        }
      }
    },
    reduced_motion: :null | :reduce | :no_preference,
    screen: %{width: integer(), height: integer()},
    service_workers: :allow | :block,
    slow_mo: number(),
    strict_selectors: boolean(),
    timeout: number() | :infinity,
    timezone_id: String.t(),
    traces_dir: String.t(),
    user_agent: String.t(),
    viewport: :null | %{width: integer(), height: integer()}
  ]
  | %{
      optional(:accept_downloads) => boolean(),
      optional(:args) => [String.t()],
      optional(:artifacts_dir) => String.t(),
      optional(:base_url) => String.t(),
      optional(:bypass_csp) => boolean(),
      optional(:channel) => String.t(),
      optional(:chromium_sandbox) => boolean(),
      optional(:client_certificates) => [
        %{
          :origin => String.t(),
          optional(:certPath) => String.t(),
          optional(:cert) => binary(),
          optional(:keyPath) => String.t(),
          optional(:key) => binary(),
          optional(:pfxPath) => String.t(),
          optional(:pfx) => binary(),
          optional(:passphrase) => String.t()
        }
      ],
      optional(:color_scheme) => :null | :light | :dark | :no_preference,
      optional(:contrast) => :null | :no_preference | :more,
      optional(:device_scale_factor) => number(),
      optional(:downloads_path) => String.t(),
      optional(:env) => %{optional(String.t()) => String.t() | nil},
      optional(:executable_path) => String.t(),
      optional(:extra_http_headers) => %{optional(String.t()) => String.t()},
      optional(:firefox_user_prefs) => %{
        optional(String.t()) => String.t() | number() | boolean()
      },
      optional(:forced_colors) => :null | :active | :none,
      optional(:geolocation) => %{
        :latitude => number(),
        :longitude => number(),
        optional(:accuracy) => number()
      },
      optional(:handle_sighup) => boolean(),
      optional(:handle_sigint) => boolean(),
      optional(:handle_sigterm) => boolean(),
      optional(:has_touch) => boolean(),
      optional(:headless) => boolean(),
      optional(:http_credentials) =>
        %{
          :username => String.t(),
          :password => String.t(),
          optional(:origin) => String.t(),
          optional(:send) => String.t()
        }
        | [
            %{
              :username => String.t(),
              :password => String.t(),
              optional(:origin) => String.t(),
              optional(:send) => String.t()
            }
          ],
      optional(:ignore_default_args) => boolean() | [String.t()],
      optional(:ignore_https_errors) => boolean(),
      optional(:is_mobile) => boolean(),
      optional(:java_script_enabled) => boolean(),
      optional(:locale) => String.t(),
      optional(:logger) => %{
        isEnabled: (String.t(), String.t() -> boolean()),
        log: (String.t(),
              String.t(),
              String.t()
              | Exception.t(),
              [map()],
              %{optional(:color) => String.t()} ->
                term())
      },
      optional(:offline) => boolean(),
      optional(:permissions) => [String.t()],
      optional(:proxy) => %{
        :server => String.t(),
        optional(:bypass) => String.t(),
        optional(:username) => String.t(),
        optional(:password) => String.t()
      },
      optional(:record_har) => %{
        optional(:omitContent) => boolean(),
        optional(:content) => String.t(),
        :path => String.t(),
        optional(:mode) => String.t(),
        optional(:urlFilter) => String.t() | Regex.t() | Playwright.RegExp.t()
      },
      optional(:record_video) => %{
        optional(:dir) => String.t(),
        optional(:size) => %{width: integer(), height: integer()},
        optional(:fps) => integer(),
        optional(:showActions) => %{
          optional(:duration) => number(),
          optional(:position) => String.t(),
          optional(:fontSize) => integer(),
          optional(:cursor) => String.t(),
          optional(:style) => %{
            optional(:point) => String.t(),
            optional(:highlight) => String.t(),
            optional(:title) => String.t()
          }
        }
      },
      optional(:reduced_motion) => :null | :reduce | :no_preference,
      optional(:screen) => %{width: integer(), height: integer()},
      optional(:service_workers) => :allow | :block,
      optional(:slow_mo) => number(),
      optional(:strict_selectors) => boolean(),
      optional(:timeout) => number() | :infinity,
      optional(:timezone_id) => String.t(),
      optional(:traces_dir) => String.t(),
      optional(:user_agent) => String.t(),
      optional(:viewport) => :null | %{width: integer(), height: integer()}
    }

Options of launch_persistent_context/3, see its docs.

t()

@type t() :: %Playwright.BrowserType{
  conn: term(),
  guid: term(),
  initializer: term(),
  table: term(),
  type: term()
}

A BrowserType handle. Compare handles with ==, their fields are internal.

Functions

connect(browser_type, endpoint, options \\ [])

@spec connect(t(), String.t(), connect_options()) ::
  {:ok, Playwright.Browser.t()} | {:error, Playwright.error()}

This method attaches Playwright to an existing browser instance created via BrowserType.launchServer in Node.js.

Note

The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).

Since Playwright 1.8.

Arguments

  • endpoint - Since Playwright 1.10. A Playwright browser websocket endpoint to connect to. You obtain this endpoint via BrowserServer.wsEndpoint.

Options

  • :expose_network (String.t/0) - Since Playwright 1.37. This option exposes network available on the connecting client to the browser being connected to. Consists of a list of rules separated by comma.

    Available rules:

    1. Hostname pattern, for example: example.com, *.org:99, x.*.y.com, *foo.org.
    2. IP literal, for example: 127.0.0.1, 0.0.0.0:99, [::1], [0:0::1]:99.
    3. <loopback> that matches local loopback interfaces: localhost, *.localhost, 127.0.0.1, [::1].

    Some common examples:

    1. "*" to expose all network.
    2. "<loopback>" to expose localhost network.
    3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" to expose test/staging deployments and localhost.
  • :headers (%{optional(String.t()) => String.t()}) - Since Playwright 1.11. Additional HTTP headers to be sent with web socket connect request. Optional.

  • :slow_mo (number/0) - Since Playwright 1.10. Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.

  • :timeout (number/0 | :infinity) - Since Playwright 1.10. Maximum time in milliseconds to wait for the connection to be established. Defaults to 0 (no timeout).

    In Elixir, :infinity is the same as 0: no timeout.

connect!(browser_type, endpoint, options \\ [])

@spec connect!(t(), String.t(), connect_options()) :: Playwright.Browser.t()

Like connect/3, but returns the value and raises on error.

connect_over_cdp(browser_type, endpoint_url, options \\ [])

@spec connect_over_cdp(t(), String.t(), connect_over_cdp_options()) ::
  {:ok, Playwright.Browser.t()} | {:error, Playwright.error()}

This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.

The default browser context is accessible via Playwright.Browser.contexts/1.

Note

Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.

Note

This connection is significantly lower fidelity than the Playwright protocol connection via Playwright.BrowserType.connect/3. If you are experiencing issues or attempting to use advanced functionality, you probably want to use Playwright.BrowserType.connect/3.

Warning

Playwright maintains a curated list of arguments for launching the browser. If you launch the browser without Playwright and do not pass the exact same arguments, some of Playwright functionality may be broken upon connecting to the browser.

Usage

browser = Playwright.chromium(playwright) |> BrowserType.connect_over_cdp!("http://localhost:9222")
default_context = Browser.contexts(browser) |> Enum.at(0)
page = BrowserContext.pages(default_context) |> Enum.at(0)

Since Playwright 1.9.

Arguments

  • endpoint_url - Since Playwright 1.11. A CDP websocket endpoint or http url to connect to. For example http://localhost:9222/ or ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4.

    Alternatively, a browser channel name such as chrome or msedge to connect to a browser with remote debugging enabled in its default user data directory. On Linux, Playwright uses CHROME_USER_DATA_DIR when set. Otherwise, it uses CHROME_CONFIG_HOME, then XDG_CONFIG_HOME, then ~/.config to locate that directory.

Options

  • :artifacts_dir (String.t/0) - Since Playwright 1.61. If specified, browser artifacts (such as traces and downloads) are saved into this directory.

  • :endpoint_url (String.t/0) - Since Playwright 1.14.

  • :headers (%{optional(String.t()) => String.t()}) - Since Playwright 1.11. Additional HTTP headers to be sent with connect request. Optional.

  • :is_local (boolean/0) - Since Playwright 1.58. Tells Playwright that it runs on the same host as the CDP server. It will enable certain optimizations that rely upon the file system being the same between Playwright and the Browser.

  • :no_defaults (boolean/0) - Since Playwright 1.60. When true, Playwright will not apply its default overrides to the existing default browser context. Specifically, :accept_downloads and font families are left at the browser's settings, focus emulation is not enabled, and media emulation options (such as :color_scheme, :reduced_motion, :forced_colors, and contrast) are not applied. Useful when attaching to a user's daily-driver browser where these overrides would interfere with existing browser state. New contexts created via Playwright.Browser.new_context/2 are not affected. Defaults to false.

  • :slow_mo (number/0) - Since Playwright 1.11. Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.

  • :timeout (number/0 | :infinity) - Since Playwright 1.11. Maximum time in milliseconds to wait for the connection to be established. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

    In Elixir, :infinity is the same as 0: no timeout.

connect_over_cdp!(browser_type, endpoint_url, options \\ [])

@spec connect_over_cdp!(t(), String.t(), connect_over_cdp_options()) ::
  Playwright.Browser.t()

Like connect_over_cdp/3, but returns the value and raises on error.

executable_path(browser_type)

@spec executable_path(t()) :: String.t()

A path where Playwright expects to find a bundled browser executable.

Since Playwright 1.8.

launch(browser_type, options \\ [])

@spec launch(t(), launch_options()) ::
  {:ok, Playwright.Browser.t()} | {:error, Playwright.error()}

Returns the browser instance.

Usage

You can use :ignore_default_args to filter out --mute-audio from default arguments:

# Or Playwright.firefox/1 or Playwright.webkit/1.
browser = BrowserType.launch!(Playwright.chromium(playwright), ignore_default_args: ["--mute-audio"])

Chromium-only Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use :executable_path option with extreme caution.

If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.

Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See this article for other differences between Chromium and Chrome. This article describes some differences for Linux users.

Since Playwright 1.8.

Options

  • :args (list of String.t/0)

    Warning

    Use custom browser args at your own risk, as some of them may break Playwright functionality.

    Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.

  • :artifacts_dir (String.t/0) - If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the browser closes.

  • :channel (String.t/0) - Browser distribution channel.

    Use "chromium" to opt in to new headless mode.

    Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.

  • :chromium_sandbox (boolean/0) - Enable Chromium sandboxing. Defaults to false.

  • :downloads_path (String.t/0) - If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.

  • :env (%{optional(String.t()) => String.t() | nil})

  • :executable_path (String.t/0) - Path to a browser executable to run instead of the bundled one. If :executable_path is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.

  • :firefox_user_prefs (%{optional(String.t()) => String.t() | number() | boolean()}) - Firefox user preferences. Learn more about the Firefox user preferences at about:config.

    You can also provide a path to a custom policies.json file via PLAYWRIGHT_FIREFOX_POLICIES_JSON environment variable.

  • :handle_sighup (boolean/0) - Close the browser process on SIGHUP. Defaults to true.

  • :handle_sigint (boolean/0) - Close the browser process on Ctrl-C. Defaults to true.

  • :handle_sigterm (boolean/0) - Close the browser process on SIGTERM. Defaults to true.

  • :headless (boolean/0) - Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true.

  • :ignore_default_args (boolean/0 | list of String.t/0) - If true, Playwright does not pass its own configurations args and only uses the ones from :args. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to false.

  • :logger (map/0) - Logger sink for Playwright logging.

    • :isEnabled - Determines whether sink is interested in the logger with the given name and severity.
    • :log
  • :proxy (map/0) - Network proxy settings.

    • :server - Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
    • :bypass - Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
    • :username - Optional username to use if HTTP proxy requires authentication.
    • :password - Optional password to use if HTTP proxy requires authentication.
  • :slow_mo (number/0) - Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.

  • :timeout (number/0 | :infinity) - Maximum time in milliseconds to wait for the browser instance to start. Defaults to 180000 (3 minutes). Pass 0 to disable timeout.

    In Elixir, :infinity is the same as 0: no timeout.

  • :traces_dir (String.t/0) - If specified, traces are saved into this directory.

launch!(browser_type, options \\ [])

@spec launch!(t(), launch_options()) :: Playwright.Browser.t()

Like launch/2, but returns the value and raises on error.

launch_persistent_context(browser_type, user_data_dir, options \\ [])

@spec launch_persistent_context(t(), String.t(), launch_persistent_context_options()) ::
  {:ok, Playwright.BrowserContext.t()} | {:error, Playwright.error()}

Returns the persistent browser context instance.

Launches browser that uses persistent storage located at user_data_dir and returns the only context. Closing this context will automatically close the browser.

Since Playwright 1.8.

Arguments

  • user_data_dir - Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty string to create a temporary directory.

    More details for Chromium and Firefox. Chromium's user data directory is the parent directory of the "Profile Path" seen at chrome://version.

    Note that browsers do not allow launching multiple instances with the same User Data Directory.

    Warning

    Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not supported. Pointing user_data_dir to Chrome's main "User Data" directory (the profile used for your regular browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example, an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port for details.

Options

  • :accept_downloads (boolean/0) - Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.

  • :args (list of String.t/0)

    Warning

    Use custom browser args at your own risk, as some of them may break Playwright functionality.

    Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.

  • :artifacts_dir (String.t/0) - If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the browser closes.

  • :base_url (String.t/0) - When using Playwright.Page.goto/3, Playwright.Page.route/4, Playwright.Page.wait_for_url/3, Playwright.Page.wait_for_request/3, or Playwright.Page.wait_for_response/3 it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples:

    • baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
    • baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
    • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
  • :bypass_csp (boolean/0) - Toggles bypassing page's Content-Security-Policy. Defaults to false.

  • :channel (String.t/0) - Browser distribution channel.

    Use "chromium" to opt in to new headless mode.

    Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.

  • :chromium_sandbox (boolean/0) - Enable Chromium sandboxing. Defaults to false.

  • :client_certificates (list of map/0) - Since Playwright 1.46. TLS Client Authentication allows the server to request a client certificate and verify it.

    Details

    An array of client certificates to be used. Each certificate object must have either both certPath and keyPath, a single pfxPath, or their corresponding direct value equivalents (cert and key, or pfx). Optionally, passphrase property should be provided if the certificate is encrypted. The origin property should be provided with an exact match to the request origin that the certificate is valid for.

    Client certificate authentication is only active when at least one client certificate is provided. If you want to reject all client certificates sent by the server, you need to provide a client certificate with an origin that does not match any of the domains you plan to visit.

    Note

    When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.

    • :origin - Exact origin that the certificate is valid for. Origin includes https protocol, a hostname and optionally a port.
    • :certPath - Path to the file with the certificate in PEM format.
    • :cert - Direct value of the certificate in PEM format.
    • :keyPath - Path to the file with the private key in PEM format.
    • :key - Direct value of the private key in PEM format.
    • :pfxPath - Path to the PFX or PKCS12 encoded private key and certificate chain.
    • :pfx - Direct value of the PFX or PKCS12 encoded private key and certificate chain.
    • :passphrase - Passphrase for the private key (PEM or PFX).
  • :color_scheme (:null | :light | :dark | :no_preference) - Emulates prefers-colors-scheme media feature, supported values are :light and :dark. See Playwright.Page.emulate_media/2 for more details. Passing :null resets emulation to system defaults. Defaults to :light.

  • :contrast (:null | :no_preference | :more) - Emulates 'prefers-contrast' media feature, supported values are :no_preference, :more. See Playwright.Page.emulate_media/2 for more details. Passing :null resets emulation to system defaults. Defaults to :no_preference.

  • :device_scale_factor (number/0) - Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.

  • :downloads_path (String.t/0) - If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.

  • :env (%{optional(String.t()) => String.t() | nil})

  • :executable_path (String.t/0) - Path to a browser executable to run instead of the bundled one. If :executable_path is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.

  • :extra_http_headers (%{optional(String.t()) => String.t()}) - An object containing additional HTTP headers to be sent with every request. Defaults to none.

  • :firefox_user_prefs (%{optional(String.t()) => String.t() | number() | boolean()}) - Since Playwright 1.40. Firefox user preferences. Learn more about the Firefox user preferences at about:config.

    You can also provide a path to a custom policies.json file via PLAYWRIGHT_FIREFOX_POLICIES_JSON environment variable.

  • :forced_colors (:null | :active | :none) - Emulates 'forced-colors' media feature, supported values are :active, :none. See Playwright.Page.emulate_media/2 for more details. Passing :null resets emulation to system defaults. Defaults to :none.

  • :geolocation (map/0)

    • :latitude - Latitude between -90 and 90.
    • :longitude - Longitude between -180 and 180.
    • :accuracy - Non-negative accuracy value. Defaults to 0.
  • :handle_sighup (boolean/0) - Close the browser process on SIGHUP. Defaults to true.

  • :handle_sigint (boolean/0) - Close the browser process on Ctrl-C. Defaults to true.

  • :handle_sigterm (boolean/0) - Close the browser process on SIGTERM. Defaults to true.

  • :has_touch (boolean/0) - Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.

  • :headless (boolean/0) - Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true.

  • :http_credentials (map/0 | list of map/0) - Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

    Pass an array to use different credentials for different origins. The first entry that matches the request origin is used, and entries with no origin match any request.

    • :username
    • :password
    • :origin - Restrain sending http credentials on specific origin (scheme://host:port).
    • :send - This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.
  • :ignore_default_args (boolean/0 | list of String.t/0) - If true, Playwright does not pass its own configurations args and only uses the ones from :args. If an array is given, then filters out the given default arguments. Dangerous option; use with care. Defaults to false.

  • :ignore_https_errors (boolean/0) - Whether to ignore HTTPS errors when sending network requests. Defaults to false.

  • :is_mobile (boolean/0) - Whether the meta viewport tag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults to false. Learn more about mobile emulation.

  • :java_script_enabled (boolean/0) - Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.

  • :locale (String.t/0) - Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.

  • :logger (map/0) - Logger sink for Playwright logging.

    • :isEnabled - Determines whether sink is interested in the logger with the given name and severity.
    • :log
  • :offline (boolean/0) - Whether to emulate network being offline. Defaults to false. Learn more about network emulation.

  • :permissions (list of String.t/0) - A list of permissions to grant to all pages in this context. See Playwright.BrowserContext.grant_permissions/3 for more details. Defaults to none.

  • :proxy (map/0) - Network proxy settings.

    • :server - Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
    • :bypass - Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
    • :username - Optional username to use if HTTP proxy requires authentication.
    • :password - Optional password to use if HTTP proxy requires authentication.
  • :record_har (map/0) - Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to call Playwright.BrowserContext.close/2 for the HAR to be saved.

    • :omitContent - Optional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use content policy instead.
    • :content - Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file as per HAR specification. Defaults to attach for .zip output files and to embed for all other file extensions.
    • :path - Path on the filesystem to write the HAR file to. If the file name ends with .zip, content: 'attach' is used by default.
    • :mode - When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.
    • :urlFilter - A glob or regex pattern to filter requests that are stored in the HAR. When a :base_url via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor. Defaults to none.
  • :record_video (map/0) - Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to call Playwright.BrowserContext.close/2 for videos to be saved.

    • :dir - Path to the directory to put videos into. If not specified, the videos will be stored in :artifacts_dir (see Playwright.BrowserType.launch/2 options).
    • :size - Optional dimensions of the recorded videos. If not specified the size will be equal to :viewport scaled down to fit into 800x800. If :viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
      • :width - Video frame width.
      • :height - Video frame height.
    • :fps - Frame rate of the recorded videos in frames per second. Defaults to 25. Firefox and WebKit currently capture up to 25 frames per second.
    • :showActions - If specified, enables visual annotations on interacted elements during video recording.
      • :duration - How long each annotation is displayed in milliseconds. Defaults to 500.
      • :position - Position of the action title overlay. Defaults to "top-right".
      • :fontSize - Font size of the action title in pixels. Defaults to 24. Deprecated, use style.title instead.
      • :cursor - Cursor decoration shown for pointer actions. "pointer" (the default) renders a mouse pointer that animates from the previous action point to the next one. "none" disables the cursor decoration.
      • :style - Styles of the action decorations.
        • :point - CSS declarations for the zero-sized marker centered on the action point. Not shown when omitted.
        • :highlight - CSS declarations for the box that covers the target element. Not shown when omitted.
        • :title - CSS declarations for the action title.
  • :reduced_motion (:null | :reduce | :no_preference) - Emulates 'prefers-reduced-motion' media feature, supported values are :reduce, :no_preference. See Playwright.Page.emulate_media/2 for more details. Passing :null resets emulation to system defaults. Defaults to :no_preference.

  • :screen (map/0) - Emulates consistent window screen size available inside web page via window.screen. Is only used when the :viewport is set.

    • :width - page width in pixels.
    • :height - page height in pixels.
  • :service_workers (:allow | :block) - Whether to allow sites to register Service workers. Defaults to :allow.

    • :allow: Service Workers can be registered.
    • :block: Playwright will block all registration of Service Workers.
  • :slow_mo (number/0) - Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.

  • :strict_selectors (boolean/0) - If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will fail when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to false. See Locator to learn more about the strict mode.

  • :timeout (number/0 | :infinity) - Maximum time in milliseconds to wait for the browser instance to start. Defaults to 180000 (3 minutes). Pass 0 to disable timeout.

    In Elixir, :infinity is the same as 0: no timeout.

  • :timezone_id (String.t/0) - Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.

  • :traces_dir (String.t/0) - If specified, traces are saved into this directory.

  • :user_agent (String.t/0) - Specific user agent to use in this context.

  • :viewport (:null | map/0) - Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use :null to disable the consistent viewport emulation. Learn more about viewport emulation.

    Note

    The :null value opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.

    • :width - page width in pixels.
    • :height - page height in pixels.

launch_persistent_context!(browser_type, user_data_dir, options \\ [])

@spec launch_persistent_context!(t(), String.t(), launch_persistent_context_options()) ::
  Playwright.BrowserContext.t()

Like launch_persistent_context/3, but returns the value and raises on error.

name(browser_type)

@spec name(t()) :: String.t()

Returns browser name. For example: 'chromium', 'webkit' or 'firefox'.

Since Playwright 1.8.