Version: Next

Getting Started

Installation#

Playwright is distributed as a set of Maven modules. The easiest way to use it is to add one dependency to your project's pom.xml as described below. If you're not familiar with Maven please refer to its documentation.

Usage#

package org.example;
import com.microsoft.playwright.*;
public class Example {
public static void main(String[] args) {
try (Playwright playwright = Playwright.create()) {
Browser browser = playwright.chromium().launch();
Page page = browser.newPage();
page.navigate("http://playwright.dev");
System.out.println(page.title());
}
}
}

With the Example.java and pom.xml above, compile and execute your new program as follows:

mvn compile exec:java -Dexec.mainClass="org.example.Example"

Running it downloads the Playwright package and installs browser binaries for Chromium, Firefox and WebKit. To modify this behavior see installation parameters.

First script#

In our first script, we will navigate to whatsmyuseragent.org and take a screenshot in WebKit.

import com.microsoft.playwright.*;
import java.nio.file.Paths;
public class WebKitScreenshot {
public static void main(String[] args) {
try (Playwright playwright = Playwright.create()) {
Browser browser = playwright.webkit().launch();
Page page = browser.newPage();
page.navigate("http://whatsmyuseragent.org/");
page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("example.png")));
}
}
}

By default, Playwright runs the browsers in headless mode. To see the browser UI, pass the headless=false flag while launching the browser. You can also use slowMo to slow down execution. Learn more in the debugging tools section.

playwright.firefox().launch(new BrowserType.LaunchOptions().setHeadless(false).setSlowMo(50));

Record scripts#

Command Line Interface CLI can be used to record user interactions and generate Java code.

$ mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="codegen wikipedia.org"

System requirements#

Playwright requires Java 8 or newer. The browser binaries for Chromium, Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):

  • Windows: Works with Windows and Windows Subsystem for Linux (WSL).
  • macOS: Requires 10.14 or above.
  • Linux: Depending on your Linux distribution, you might need to install additional dependencies to run the browsers.
    • Firefox requires Ubuntu 18.04+
    • For Ubuntu 20.04, the additional dependencies are defined in our Docker image, which is based on Ubuntu.