id	title	toc_max_heading_level
release-notes	Release notes	2

Version 1.28

Playwright Tools

Live Locators in CodeGen. Generate a locator for any element on the page using "Explore" tool.

New APIs

[method: Locator.blur]
[method: Locator.clear]

Browser Versions

Chromium 108.0.5359.29
Mozilla Firefox 106.0
WebKit 16.4

This version was also tested against the following stable channels:

Google Chrome 107
Microsoft Edge 107

Version 1.27

Locators

With these new APIs writing locators is a joy:

[method: Page.getByText] to locate by text content.
[method: Page.getByRole] to locate by ARIA role, ARIA attributes and accessible name.
[method: Page.getByLabel] to locate a form control by associated label's text.
[method: Page.getByTestId] to locate an element based on its data-testid attribute (other attribute can be configured).
[method: Page.getByPlaceholder] to locate an input by placeholder.
[method: Page.getByAltText] to locate an element, usually image, by its text alternative.
[method: Page.getByTitle] to locate an element by its title.

page.getByLabel("User Name").fill("John");

page.getByLabel("Password").fill("secret-password");

page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Sign in")).click();

assertThat(page.getByText("Welcome, John!")).isVisible();

All the same methods are also available on [Locator], [FrameLocator] and [Frame] classes.

Other highlights

As announced in v1.25, Ubuntu 18 will not be supported as of Dec 2022. In addition to that, there will be no WebKit updates on Ubuntu 18 starting from the next Playwright release.

Behavior Changes

[method: LocatorAssertions.toHaveAttribute] with an empty value does not match missing attribute anymore. For example, the following snippet will succeed when button does not have a disabled attribute.
```
assertThat(page.getByRole(AriaRole.BUTTON)).hasAttribute("disabled", "");
```

Browser Versions

Chromium 107.0.5304.18
Mozilla Firefox 105.0.1
WebKit 16.0

This version was also tested against the following stable channels:

Google Chrome 106
Microsoft Edge 106

Version 1.26

Assertions

New option enabled for [method: LocatorAssertions.toBeEnabled].
[method: LocatorAssertions.toHaveText] now pierces open shadow roots.
New option editable for [method: LocatorAssertions.toBeEditable].
New option visible for [method: LocatorAssertions.toBeVisible].

Other highlights

New option setMaxRedirects for [method: APIRequestContext.get] and others to limit redirect count.
Docker images are now using OpenJDK 17.

Behavior Change

A bunch of Playwright APIs already support the setWaitUntil(WaitUntilState.DOMCONTENTLOADED) option. For example:

page.navigate("https://playwright.dev", new Page.NavigateOptions().setWaitUntil(WaitUntilState.DOMCONTENTLOADED));

Prior to 1.26, this would wait for all iframes to fire the DOMContentLoaded event.

To align with web specification, the WaitUntilState.DOMCONTENTLOADED value only waits for the target frame to fire the 'DOMContentLoaded' event. Use setWaitUntil(WaitUntilState.LOAD) to wait for all iframes.

Browser Versions

Chromium 106.0.5249.30
Mozilla Firefox 104.0
WebKit 16.0

This version was also tested against the following stable channels:

Google Chrome 105
Microsoft Edge 105

Version 1.25

New APIs & changes

Default assertions timeout now can be changed with setDefaultAssertionTimeout.

Announcements

🪦 This is the last release with macOS 10.15 support (deprecated as of 1.21).
⚠️ Ubuntu 18 is now deprecated and will not be supported as of Dec 2022.

Browser Versions

Chromium 105.0.5195.19
Mozilla Firefox 103.0
WebKit 16.0

This version was also tested against the following stable channels:

Google Chrome 104
Microsoft Edge 104

Version 1.24

🐂 Debian 11 Bullseye Support

Playwright now supports Debian 11 Bullseye on x86_64 for Chromium, Firefox and WebKit. Let us know if you encounter any issues!

Linux support looks like this:

	Ubuntu 18.04	Ubuntu 20.04	Ubuntu 22.04	Debian 11
Chromium	✅	✅	✅	✅
WebKit	✅	✅	✅	✅
Firefox	✅	✅	✅	✅

Version 1.23

Network Replay

Now you can record network traffic into a HAR file and re-use this traffic in your tests.

To record network into HAR file:

mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="open --save-har=example.har --save-har-glob='**/api/**' https://example.com"

Alternatively, you can record HAR programmatically:

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
    .setRecordHarPath(Paths.get("example.har"))
    .setRecordHarUrlFilter("**/api/**"));

// ... Perform actions ...

// Close context to ensure HAR is saved to disk.
context.close();

Use the new methods [method: Page.routeFromHAR] or [method: BrowserContext.routeFromHAR] to serve matching responses from the HAR file:

context.routeFromHAR(Paths.get("example.har"));

Advanced Routing

You can now use [method: Route.fallback] to defer routing to other handlers.

Consider the following example:

// Remove a header from all requests.
page.route("**/*", route -> {
  Map<String, String> headers = new HashMap<>(route.request().headers());
  headers.remove("X-Secret");
  route.resume(new Route.ResumeOptions().setHeaders(headers));
});

// Abort all images.
page.route("**/*", route -> {
  if ("image".equals(route.request().resourceType()))
    route.abort();
  else
    route.fallback();
});

Note that the new methods [method: Page.routeFromHAR] and [method: BrowserContext.routeFromHAR] also participate in routing and could be deferred to.

Web-First Assertions Update

New method [method: LocatorAssertions.toHaveValues] that asserts all selected values of <select multiple> element.
Methods [method: LocatorAssertions.toContainText] and [method: LocatorAssertions.toHaveText] now accept ignoreCase option.

Miscellaneous

If there's a service worker that's in your way, you can now easily disable it with a new context option serviceWorkers:

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
    .setServiceWorkers(ServiceWorkerPolicy.BLOCK));

Using .zip path for recordHar context option automatically zips the resulting HAR:

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
    .setRecordHarPath(Paths.get("example.har.zip")));

If you intend to edit HAR by hand, consider using the "minimal" HAR recording mode that only records information that is essential for replaying:

BrowserContext context = browser.newContext(new Browser.NewContextOptions()
    .setRecordHarPath(Paths.get("example.har"))
    .setRecordHarMode(HarMode.MINIMAL));

Playwright now runs on Ubuntu 22 amd64 and Ubuntu 22 arm64.

Version 1.22

Highlights

Role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.
```
// Click a button with accessible name "log in"
page.locator("role=button[name='log in']").click();
```
Read more in our documentation.

New [method: Locator.filter] API to filter an existing locator

Locator buttonsLocator = page.locator("role=button");
// ...
Locator submitButton = buttonsLocator.filter(new Locator.FilterOptions().setHasText("Submit"));
submitButton.click();

Playwright for Java now supports Ubuntu 20.04 ARM64 and Apple M1. You can now run Playwright for Java tests on Apple M1, inside Docker on Apple M1, and on Raspberry Pi.

Version 1.21

Highlights

New role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.
```
// Click a button with accessible name "log in"
page.locator("role=button[name='log in']").click();
```
Read more in our documentation.
New scale option in [method: Page.screenshot] for smaller sized screenshots.
New caret option in [method: Page.screenshot] to control text caret. Defaults to "hide".

Behavior Changes

Playwright now supports large file uploads (100s of MBs) via [method: Locator.setInputFiles] API.

Browser Versions

Chromium 101.0.4951.26
Mozilla Firefox 98.0.2
WebKit 15.4

This version was also tested against the following stable channels:

Google Chrome 100
Microsoft Edge 100

Version 1.20

Highlights

New options for methods [method: Page.screenshot], [method: Locator.screenshot] and [method: ElementHandle.screenshot]:
- Option ScreenshotAnimations.DISABLED rewinds all CSS animations and transitions to a consistent state
- Option mask: Locator[] masks given elements, overlaying them with pink #FF00FF boxes.
Trace Viewer now shows API testing requests.
[method: Locator.highlight] visually reveals element(s) for easier debugging.

Announcements

v1.20 is the last release to receive WebKit update for macOS 10.15 Catalina. Please update MacOS to keep using latest & greatest WebKit!

Browser Versions

Chromium 101.0.4921.0
Mozilla Firefox 97.0.1
WebKit 15.4

This version was also tested against the following stable channels:

Google Chrome 99
Microsoft Edge 99

Version 1.19

Highlights

Locator now supports a has option that makes sure it contains another locator inside:
```
page.locator("article", new Page.LocatorOptions().setHas(page.locator(".highlight"))).click();
```
Read more in locator documentation
New [method: Locator.page]
[method: Page.screenshot] and [method: Locator.screenshot] now automatically hide blinking caret
Playwright Codegen now generates locators and frame locators

Browser Versions

Chromium 100.0.4863.0
Mozilla Firefox 96.0.1
WebKit 15.4

This version was also tested against the following stable channels:

Google Chrome 98
Microsoft Edge 98

Version 1.18

API Testing

Playwright for Java 1.18 introduces new API Testing that lets you send requests to the server directly from Java! Now you can:

test your server API
prepare server side state before visiting the web application in a test
validate server side post-conditions after running some actions in the browser

To do a request on behalf of Playwright's Page, use new [property: Page.request] API:

// Do a GET request on behalf of page
APIResponse res = page.request().get("http://example.com/foo.json");

Read more about it in our API testing guide.

Web-First Assertions

Playwright for Java 1.18 introduces Web-First Assertions.

Consider the following example:

...
import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;

public class TestExample {
  ...
  @Test
  void statusBecomesSubmitted() {
    ...
    page.locator("#submit-button").click();
    assertThat(page.locator(".status")).hasText("Submitted");
  }
}

Playwright will be re-testing the node with the selector .status until fetched Node has the "Submitted" text. It will be re-fetching the node and checking it over and over, until the condition is met or until the timeout is reached. You can pass this timeout as an option.

Locator Improvements

[method: Locator.dragTo]

Each locator can now be optionally filtered by the text it contains:

page.locator("li", new Page.LocatorOptions().setHasText("my item"))
    .locator("button").click();

Tracing Improvements

Tracing now can embed Java sources to recorded traces, using new setSources option.

New APIs & changes

acceptDownloads option now defaults to true.

Browser Versions

Chromium 99.0.4812.0
Mozilla Firefox 95.0
WebKit 15.4

This version was also tested against the following stable channels:

Google Chrome 97
Microsoft Edge 97

Version 1.17

Frame Locators

Playwright 1.17 introduces frame locators - a locator to the iframe on the page. Frame locators capture the logic sufficient to retrieve the iframe and then locate elements in that iframe. Frame locators are strict by default, will wait for iframe to appear and can be used in Web-First assertions.

Frame locators can be created with either [method: Page.frameLocator] or [method: Locator.frameLocator] method.

Locator locator = page.frameLocator("#my-frame").locator("text=Submit");
locator.click();

Trace Viewer Update

Playwright Trace Viewer is now available online at https://trace.playwright.dev! Just drag-and-drop your trace.zip file to inspect its contents.

NOTE: trace files are not uploaded anywhere; trace.playwright.dev is a progressive web application that processes traces locally.

Playwright Test traces now include sources by default (these could be turned off with tracing option)
Trace Viewer now shows test name
New trace metadata tab with browser details
Snapshots now have URL bar

HTML Report Update

HTML report now supports dynamic filtering
Report is now a single static HTML file that could be sent by e-mail or as a slack attachment.

Ubuntu ARM64 support + more

Playwright now supports Ubuntu 20.04 ARM64. You can now run Playwright tests inside Docker on Apple M1 and on Raspberry Pi.

You can now use Playwright to install stable version of Edge on Linux:

mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="install msedge"

New APIs

Tracing now supports a 'title' option
Page navigations support a new 'commit' waiting option

Version 1.16

🎭 Playwright Library

Locator.waitFor

Wait for a locator to resolve to a single element with a given state. Defaults to the state: 'visible'.

Locator orderSent = page.locator("#order-sent");
orderSent.waitFor();

Read more about [method: Locator.waitFor].

🎭 Playwright Trace Viewer

run trace viewer with mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="show-trace" and drop trace files to the trace viewer PWA
better visual attribution of action targets

Browser Versions

Chromium 97.0.4666.0
Mozilla Firefox 93.0
WebKit 15.4

This version of Playwright was also tested against the following stable channels:

Google Chrome 94
Microsoft Edge 94

Version 1.15

🖱️ Mouse Wheel

By using Mouse.wheel you are now able to scroll vertically or horizontally.

📜 New Headers API

Previously it was not possible to get multiple header values of a response. This is now possible and additional helper functions are available:

Request.allHeaders()
Request.headersArray()
Request.headerValue(name: string)
Response.allHeaders()
Response.headersArray()
Response.headerValue(name: string)
Response.headerValues(name: string)

🌈 Forced-Colors emulation

Its now possible to emulate the forced-colors CSS media feature by passing it in the context options or calling Page.emulateMedia().

New APIs

Page.route() accepts new times option to specify how many times this route should be matched.
Page.setChecked(selector: string, checked: boolean) and Locator.setChecked(selector: string, checked: boolean) was introduced to set the checked state of a checkbox.
Request.sizes() Returns resource size information for given http request.
Tracing.startChunk() - Start a new trace chunk.
Tracing.stopChunk() - Stops a new trace chunk.

Browser Versions

Chromium 96.0.4641.0
Mozilla Firefox 92.0
WebKit 15.0

Version 1.14

⚡️ New "strict" mode

Selector ambiguity is a common problem in automation testing. "strict" mode ensures that your selector points to a single element and throws otherwise.

Set setStrict(true) in your action calls to opt in.

// This will throw if you have more than one button!
page.click("button", new Page.ClickOptions().setStrict(true));

📍 New Locators API

Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any given moment.

The difference between the Locator and ElementHandle is that the latter points to a particular element, while Locator captures the logic of how to retrieve that element.

Also, locators are "strict" by default!

Locator locator = page.locator("button");
locator.click();

Learn more in the documentation.

🧩 Experimental React and Vue selector engines

React and Vue selectors allow selecting elements by its component name and/or property values. The syntax is very similar to attribute selectors and supports all attribute selector operators.

page.locator("_react=SubmitButton[enabled=true]").click();
page.locator("_vue=submit-button[enabled=true]").click();

Learn more in the react selectors documentation and the vue selectors documentation.

✨ New `nth` and `visible` selector engines

nth selector engine is equivalent to the :nth-match pseudo class, but could be combined with other selector engines.
visible selector engine is equivalent to the :visible pseudo class, but could be combined with other selector engines.

// select the first button among all buttons
button.click("button >> nth=0");
// or if you are using locators, you can use first(), nth() and last()
page.locator("button").first().click();

// click a visible button
button.click("button >> visible=true");

Browser Versions

Chromium 94.0.4595.0
Mozilla Firefox 91.0
WebKit 15.0

Version 1.13

Playwright

🖖 Programmatic drag-and-drop support via the [method: Page.dragAndDrop] API.
🔎 Enhanced HAR with body sizes for requests and responses. Use via recordHar option in [method: Browser.newContext].

Tools

Playwright Trace Viewer now shows parameters, returned values and console.log() calls.

New and Overhauled Guides

Intro
Authentication

Browser Versions

Chromium 93.0.4576.0
Mozilla Firefox 90.0
WebKit 14.2

New Playwright APIs

new baseURL option in [method: Browser.newContext] and [method: Browser.newPage]
[method: Response.securityDetails] and [method: Response.serverAddr]
[method: Page.dragAndDrop] and [method: Frame.dragAndDrop]
[method: Download.cancel]
[method: Page.inputValue], [method: Frame.inputValue] and [method: ElementHandle.inputValue]
new force option in [method: Page.fill], [method: Frame.fill], and [method: ElementHandle.fill]
new force option in [method: Page.selectOption], [method: Frame.selectOption], and [method: ElementHandle.selectOption]

Version 1.12

🧟‍♂️ Introducing Playwright Trace Viewer

Playwright Trace Viewer is a new GUI tool that helps exploring recorded Playwright traces after the script ran. Playwright traces let you examine:

page DOM before and after each Playwright action
page rendering before and after each Playwright action
browser network during script execution

Traces are recorded using the new [property: BrowserContext.tracing] API:

Browser browser = chromium.launch();
BrowserContext context = browser.newContext();

// Start tracing before creating / navigating a page.
context.tracing.start(new Tracing.StartOptions()
  .setScreenshots(true)
  .setSnapshots(true);

Page page = context.newPage();
page.goto("https://playwright.dev");

// Stop tracing and export it into a zip archive.
context.tracing.stop(new Tracing.StopOptions()
  .setPath(Paths.get("trace.zip")));

Traces are examined later with the Playwright CLI:

mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="show-trace trace.zip"

That will open the following GUI:

👉 Read more in trace viewer documentation.

Browser Versions

Chromium 93.0.4530.0
Mozilla Firefox 89.0
WebKit 14.2

This version of Playwright was also tested against the following stable channels:

Google Chrome 91
Microsoft Edge 91

New APIs

reducedMotion option in [method: Page.emulateMedia], [method: BrowserType.launchPersistentContext], [method: Browser.newContext] and [method: Browser.newPage]
[event: BrowserContext.request]
[event: BrowserContext.requestFailed]
[event: BrowserContext.requestFinished]
[event: BrowserContext.response]
tracesDir option in [method: BrowserType.launch] and [method: BrowserType.launchPersistentContext]
new [property: BrowserContext.tracing] API namespace
new [method: Download.page] method

Version 1.11

🎥 New video: Playwright: A New Test Automation Framework for the Modern Web (slides)

We talked about Playwright
Showed engineering work behind the scenes
Did live demos with new features ✨
Special thanks to applitools for hosting the event and inviting us!

Browser Versions

Chromium 92.0.4498.0
Mozilla Firefox 89.0b6
WebKit 14.2

New APIs

support for async predicates across the API in methods such as [method: Page.waitForRequest] and others
new emulation devices: Galaxy S8, Galaxy S9+, Galaxy Tab S4, Pixel 3, Pixel 4
new methods:
- [method: Page.waitForURL] to await navigations to URL
- [method: Video.delete] and [method: Video.saveAs] to manage screen recording
new options:
- screen option in the [method: Browser.newContext] method to emulate window.screen dimensions
- position option in [method: Page.check] and [method: Page.uncheck] methods
- trial option to dry-run actions in [method: Page.check], [method: Page.uncheck], [method: Page.click], [method: Page.dblclick], [method: Page.hover] and [method: Page.tap]

Version 1.10

Playwright for Java v1.10 is now stable!
Run Playwright against Google Chrome and Microsoft Edge stable channels with the new channels API.
Chromium screenshots are fast on Mac & Windows.

Bundled Browser Versions

Chromium 90.0.4430.0
Mozilla Firefox 87.0b10
WebKit 14.2

This version of Playwright was also tested against the following stable channels:

Google Chrome 89
Microsoft Edge 89

New APIs

browserType.launch() now accepts the new 'channel' option. Read more in our documentation.

Version 1.9

Playwright Inspector is a new GUI tool to author and debug your tests.
- Line-by-line debugging of your Playwright scripts, with play, pause and step-through.
- Author new scripts by recording user actions.
- Generate element selectors for your script by hovering over elements.
- Set the PWDEBUG=1 environment variable to launch the Inspector
Pause script execution with [method: Page.pause] in headed mode. Pausing the page launches Playwright Inspector for debugging.
New has-text pseudo-class for CSS selectors. :has-text("example") matches any element containing "example" somewhere inside, possibly in a child or a descendant element. See more examples.
Page dialogs are now auto-dismissed during execution, unless a listener for dialog event is configured. Learn more about this.
Playwright for Python is now stable with an idiomatic snake case API and pre-built Docker image to run tests in CI/CD.

Browser Versions

Chromium 90.0.4421.0
Mozilla Firefox 86.0b10
WebKit 14.1

New APIs

[method: Page.pause].

Version 1.8

Selecting elements based on layout with :left-of(), :right-of(), :above() and :below().

Playwright now includes command line interface, former playwright-cli.

mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="--help"

[method: Page.selectOption] now waits for the options to be present.
New methods to assert element state like [method: Page.isEditable].

New APIs

[method: ElementHandle.isChecked].
[method: ElementHandle.isDisabled].
[method: ElementHandle.isEditable].
[method: ElementHandle.isEnabled].
[method: ElementHandle.isHidden].
[method: ElementHandle.isVisible].
[method: Page.isChecked].
[method: Page.isDisabled].
[method: Page.isEditable].
[method: Page.isEnabled].
[method: Page.isHidden].
[method: Page.isVisible].
New option 'editable' in [method: ElementHandle.waitForElementState].

Browser Versions

Chromium 90.0.4392.0
Mozilla Firefox 85.0b5
WebKit 14.1

Version 1.7

New Java SDK: Playwright for Java is now on par with JavaScript, Python and .NET bindings.
Browser storage API: New convenience APIs to save and load browser storage state (cookies, local storage) to simplify automation scenarios with authentication.
New CSS selectors: We heard your feedback for more flexible selectors and have revamped the selectors implementation. Playwright 1.7 introduces new CSS extensions and there's more coming soon.
New website: The docs website at playwright.dev has been updated and is now built with Docusaurus.
Support for Apple Silicon: Playwright browser binaries for WebKit and Chromium are now built for Apple Silicon.

New APIs

[method: BrowserContext.storageState] to get current state for later reuse.
storageState option in [method: Browser.newContext] and [method: Browser.newPage] to setup browser context state.

Browser Versions

Chromium 89.0.4344.0
Mozilla Firefox 84.0b9
WebKit 14.1

Files

release-notes-java.md

Latest commit

History

release-notes-java.md

File metadata and controls

Version 1.28

Playwright Tools

New APIs

Browser Versions

Version 1.27

Locators

Other highlights

Behavior Changes

Browser Versions

Version 1.26

Assertions

Other highlights

Behavior Change

Browser Versions

Version 1.25

New APIs & changes

Announcements

Browser Versions

Version 1.24

🐂 Debian 11 Bullseye Support

Version 1.23

Network Replay

Advanced Routing

Web-First Assertions Update

Miscellaneous

Version 1.22

Highlights

Version 1.21

Highlights

Behavior Changes

Browser Versions

Version 1.20

Highlights

Announcements

Browser Versions

Version 1.19

Highlights

Browser Versions

Version 1.18

API Testing

Web-First Assertions

Locator Improvements

Tracing Improvements

New APIs & changes

Browser Versions

Version 1.17

Frame Locators

Trace Viewer Update

HTML Report Update

Ubuntu ARM64 support + more

New APIs

Version 1.16

🎭 Playwright Library

Locator.waitFor

🎭 Playwright Trace Viewer

Browser Versions

Version 1.15

🖱️ Mouse Wheel

📜 New Headers API

🌈 Forced-Colors emulation

New APIs

Browser Versions

Version 1.14

⚡️ New "strict" mode

📍 New Locators API

🧩 Experimental React and Vue selector engines

✨ New nth and visible selector engines

Browser Versions

Version 1.13

Playwright

Tools

New and Overhauled Guides

Browser Versions

New Playwright APIs

✨ New `nth` and `visible` selector engines