Elixir client for Playwright. Automate Chromium, Firefox and WebKit: end-to-end tests, web scraping, agentic AI.
It is a 1:1 port of the official JavaScript client. Its API is generated from
Playwright's docs, so the docs at playwright.dev apply. The driver (Node.js and playwright-core)
is pinned and installed by Mix, no npm needed. This release drives Playwright 1.65.1, the
version Playwright's Docker image tag must have (v1.65.1-noble).
For Phoenix feature tests with the Ecto sandbox, use Fluffy, which is built on this library.
What's ported shows which parts of the client and of Playwright Test are ported.
Installation
def deps do
[
{:playwright, "~> 1.65.0-rc.3", hex: :playwright_ex}
]
endThe Hex package is playwright_ex, the app and modules are playwright and Playwright.
hex: :playwright_ex is required: playwright on Hex is another library.
mix deps.get
mix playwright.install
Arguments are playwright install's: mix playwright.install chromium --with-deps.
Versioning
The major.minor is Playwright's and the patch is ours, as in playwright-python: 1.65.x drives
Playwright 1.65. Our own breaking changes ship only with a Playwright minor, so depend on
~> 1.65.0.
Example
alias Playwright.{Browser, BrowserType, Expect, Locator, Page}
{:ok, _} = Playwright.Supervisor.start_link()
browser = BrowserType.launch!(Playwright.chromium(Playwright.instance()))
page = Browser.new_page!(browser)
Page.goto!(page, "https://elixir-lang.org/")
Page.get_by_role(page, :link, name: "Install") |> Locator.click!()
Expect.to_have_title!(page, ~r/Install/)
# Closes the browser and waits for the driver to exit before the VM halts.
Supervisor.stop(Playwright)For no timeout, pass timeout: :infinity; 0 also means no timeout, unlike Elixir's convention
(details).
Reading playwright.dev
The Python docs are the closest read, since the
names match Python's: snake_case, keyword options, expect_popup, eval_on_selector.
page.get_by_role("button").click() is Page.get_by_role(page, :button) |> Locator.click!().
Guides
- Getting started: install, the driver, a first script, usage rules for coding agents.
- What's ported: the client and Playwright Test, at a glance.
- From playwright.dev to Elixir: how a JS call reads in Elixir.
- Cheatsheet: frequent calls, JS next to Elixir.
- Testing with ExUnit:
Playwright.TestandPlaywright.Case, assertions, steps; then options, devices and projects, artifacts, retries and workers and porting Playwright Test specs. - Events and waiting, Network, Debugging and CI.
- Concurrency: listeners, promises and processes.
Feedback of any shape and size is welcome: get in touch.
Contributing
See CONTRIBUTING.md.
License
Apache-2.0 (LICENSE), as the client is a
port of Playwright's: see NOTICE. Each
ported file starts with its upstream file's copyright header. Releases up to 0.16 were MIT.