docs/src/release-notes-csharp.md
import LiteYouTube from '@site/src/components/LiteYouTube';
New [property: Page.screencast] API provides a unified interface for capturing page content with:
Screencast recording ā record video with precise start/stop control, as an alternative to the [option: Browser.newContext.recordVideoDir] option:
await page.Screencast.StartAsync(new() { Path = "video.webm" });
// ... perform actions ...
await page.Screencast.StopAsync();
Action annotations ā enable built-in visual annotations that highlight interacted elements and display action titles during recording:
await page.Screencast.ShowActionsAsync(new() { Position = "top-right" });
ShowActionsAsync accepts Position ("top-left", "top", "top-right", "bottom-left", "bottom", "bottom-right"), Duration (ms per annotation), and FontSize (px). Returns a disposable to stop showing actions.
Visual overlays ā add chapter titles and custom HTML overlays on top of the page for richer narration:
await page.Screencast.ShowChapterAsync("Adding TODOs", new() {
Description = "Type and press enter for each TODO",
Duration = 1000,
});
await page.Screencast.ShowOverlayAsync("<div style=\"color: red\">Recording</div>");
Real-time frame capture ā stream JPEG-encoded frames for custom processing like thumbnails, live previews, AI vision, and more:
await page.Screencast.StartAsync(new() {
OnFrame = frame => SendToVisionModel(frame.Data),
});
Agentic video receipts ā coding agents can produce video evidence of their work. After completing a task, an agent can record a walkthrough video with rich annotations for human review:
await page.Screencast.StartAsync(new() { Path = "receipt.webm" });
await page.Screencast.ShowActionsAsync(new() { Position = "top-right" });
await page.Screencast.ShowChapterAsync("Verifying checkout flow", new() {
Description = "Added coupon code support per ticket #1234",
});
// Agent performs the verification steps...
await page.Locator("#coupon").FillAsync("SAVE20");
await page.Locator("#apply-coupon").ClickAsync();
await Expect(page.Locator(".discount")).ToContainTextAsync("20%");
await page.Screencast.ShowChapterAsync("Done", new() {
Description = "Coupon applied, discount reflected in total",
});
await page.Screencast.StopAsync();
The resulting video serves as a receipt: chapter titles provide context, action annotations highlight each interaction, and the visual walkthrough is faster to review than text logs.
method: Page.ariaSnapshot] to capture the aria snapshot of the page ā equivalent to Page.Locator("body").AriaSnapshotAsync().Depth and Mode in [method: Locator.ariaSnapshot].method: Locator.normalize] converts a locator to follow best practices like test ids and aria roles.method: Page.pickLocator] enters an interactive mode where hovering over elements highlights them and shows the corresponding locator. Click an element to get its [Locator] back. Use [method: Page.cancelPickLocator] to cancel.property: Page.screencast] provides video recording, real-time frame streaming, and overlay management.method: Screencast.start] and [method: Screencast.stop] for recording and frame capture.method: Screencast.showActions] and [method: Screencast.hideActions] for action annotations.method: Screencast.showChapter] and [method: Screencast.showOverlay] for visual overlays.method: Screencast.showOverlays] and [method: Screencast.hideOverlays] for overlay visibility control.method: BrowserContext.setStorageState] clears existing cookies, local storage, and IndexedDB for all origins and sets a new storage state ā no need to create a new context.method: Page.clearConsoleMessages] and [method: Page.clearPageErrors] to clear stored messages and errors.Filter in [method: Page.consoleMessages] and [method: Page.pageErrors] controls which messages are returned.method: ConsoleMessage.timestamp].property: BrowserContext.debugger] provides programmatic control over the Playwright debugger.method: BrowserContext.isClosed].method: Request.existingResponse] returns the response without waiting.method: Response.httpVersion] returns the HTTP version used by the response.Live in [method: Tracing.start] for real-time trace updates.ArtifactsDir in [method: BrowserType.launch] to configure the artifacts directory.New [method: Browser.bind] API makes a launched browser available for playwright-cli, @playwright/mcp, and other clients to connect to.
Bind a browser ā start a browser and bind it so others can connect:
var serverInfo = await browser.BindAsync("my-session", new() {
WorkspaceDir = "/my/project",
});
Connect from playwright-cli ā connect to the running browser from your favorite coding agent.
playwright-cli attach my-session
playwright-cli -s my-session snapshot
Connect from @playwright/mcp ā or point your MCP server to the running browser.
@playwright/mcp --endpoint=my-session
Connect from a Playwright client ā use API to connect to the browser. Multiple clients at a time are supported!
var browser = await chromium.ConnectAsync(serverInfo.Endpoint);
Pass Host and Port options to bind over WebSocket instead of a named pipe:
var serverInfo = await browser.BindAsync("my-session", new() {
Host = "localhost",
Port = 0,
});
// serverInfo.Endpoint is a ws:// URL
Call [method: Browser.unbind] to stop accepting new connections.
Run playwright-cli show to open the Dashboard that lists all the bound browsers, their statuses, and allows interacting with them:
playwright-cli binds all of its browsers automatically, so you can see what your agents are doing.PLAYWRIGHT_DASHBOARD=1 env variable to see all @playwright/test browsers in the dashboard.This version was also tested against the following stable channels:
Thanks to @cpAdm for contributing these improvements!
[method: BrowserType.connectOverCDP] now accepts an IsLocal option. When set to true, it tells Playwright that it runs on the same host as the CDP server, enabling file system optimizations.
Removed _react and _vue selectors. See locators guide for alternatives.
Removed :light selector engine suffix. Use standard CSS selectors instead.
Option Devtools from [method: BrowserType.launch] has been removed. Use Args = new[] { "--auto-open-devtools-for-tabs" } instead.
Removed macOS 13 support for WebKit. We recommend to upgrade your macOS version, or keep using an older Playwright version.
This version was also tested against the following stable channels:
Playwright now runs on Chrome for Testing builds rather than Chromium. Headed mode uses chrome; headless mode uses chrome-headless-shell. Existing tests should continue to pass after upgrading to v1.57.
We're expecting no functional changes to come from this switch. The biggest change is the new icon and title in your toolbar.
If you still see an unexpected behaviour change, please file an issue.
On Arm64 Linux, Playwright continues to use Chromium.
After 3 years of being deprecated, we removed Page.Accessibility from our API. Please use other libraries such as Axe if you need to test page accessibility. See our Node.js guide for integration with Axe.
event: Worker.console] event is emitted when JavaScript within the worker calls one of console API methods, e.g. console.log or console.dir.method: Locator.description] returns locator description previously set with [method: Locator.describe].option: Locator.click.steps] in [method: Locator.click] and [method: Locator.dragTo] that configures the number of mousemove events emitted while moving the mouse pointer to the target element.method: Page.consoleMessages] and [method: Page.pageErrors] for retrieving the most recent console messages from the pagemethod: Page.requests] for retrieving the most recent network requests from the pageevent: BrowserContext.backgroundPage] has been deprecated and will not be emitted. Method [method: BrowserContext.backgroundPages] will return an empty listinput placeholderToBeVisibleAsync() assertions: Codegen can now generate automatic ToBeVisibleAsync() assertions for common UI interactions. This feature can be enabled in the Codegen settings UI.Microsoft.Playwright.Xunit.v3Microsoft.Playwright.MSTest.v4This version was also tested against the following stable channels:
New cookie property PartitionKey in [method: BrowserContext.cookies] and [method: BrowserContext.addCookies]. This property allows to save and restore partitioned cookies. See CHIPS MDN article for more information. Note that browsers have different support and defaults for cookie partitioning.
New option --user-data-dir in multiple commands. You can specify the same user data dir to reuse browsing state, like authentication, between sessions.
pwsh bin/Debug/netX/playwright.ps1 codegen --user-data-dir=./user-data
pwsh bin/Debug/netX/playwright.ps1 open does not open the test recorder anymore. Use pwsh bin/Debug/netX/playwright.ps1 codegen instead.
This version was also tested against the following stable channels:
New Steps in Trace Viewer:
New method [method: Locator.describe] to describe a locator. Used for trace viewer.
var button = Page.GetByTestId("btn-sub").Describe("Subscribe button");
await button.ClickAsync();
pwsh bin/Debug/netX/playwright.ps1 install --list will now list all installed browsers, versions and locations.
This version was also tested against the following stable channels:
New method [method: LocatorAssertions.toContainClass] to ergonomically assert individual class names on the element.
await Expect(Page.GetByRole(AriaRole.Listitem, new() { Name = "Ship v1.52" })).ToContainClassAsync("done");
Aria Snapshots got two new properties: /children for strict matching and /url for links.
await Expect(locator).ToMatchAriaSnapshotAsync(@"
- list
- /children: equal
- listitem: Feature A
- listitem:
- link ""Feature B"":
- /url: ""https://playwright.dev""
");
option: APIRequest.newContext.maxRedirects] in [method: APIRequest.newContext] to control the maximum number of redirects.method: Page.route] do not support ? and [] anymore. We recommend using regular expressions instead.method: Route.continue] does not allow to override the Cookie header anymore. If a Cookie header is provided, it will be ignored, and the cookie will be loaded from the browser's cookie store. To set custom cookies, use [method: BrowserContext.addCookies].This version was also tested against the following stable channels:
New option [option: BrowserContext.storageState.indexedDB] for [method: BrowserContext.storageState] allows to save and restore IndexedDB contents. Useful when your application uses IndexedDB API to store authentication tokens, like Firebase Authentication.
Here is an example following the authentication guide:
// Save storage state into the file. Make sure to include IndexedDB.
await context.StorageStateAsync(new()
{
Path = "../../../playwright/.auth/state.json",
IndexedDB = true
});
// Create a new context with the saved storage state.
var context = await browser.NewContextAsync(new()
{
StorageStatePath = "../../../playwright/.auth/state.json"
});
New option [option: Locator.filter.visible] for [method: Locator.filter] allows matching only visible elements.
// Ignore invisible todo items.
var todoItems = Page.GetByTestId("todo-item").Filter(new() { Visible = true });
// Check there are exactly 3 visible ones.
await Expect(todoItems).ToHaveCountAsync(3);
New option Contrast for methods [method: Page.emulateMedia] and [method: Browser.newContext] allows to emulate the prefers-contrast media feature.
New option [option: APIRequest.newContext.failOnStatusCode] makes all fetch requests made through the [APIRequestContext] throw on response codes other than 2xx and 3xx.
This version was also tested against the following stable channels:
method: LocatorAssertions.toHaveAccessibleErrorMessage] to assert the Locator points to an element with a given aria errormessage.canvas content in traces is error-prone. Display is now disabled by default, and can be enabled via the Display canvas content UI setting.Call and Network panels now display additional time information.method: LocatorAssertions.toBeEditable] and [method: Locator.isEditable] now throw if the target element is not <input>, <select>, or a number of other editable elements.This version was also tested against the following stable channels:
New assertion [method: LocatorAssertions.toMatchAriaSnapshot] verifies page structure by comparing to an expected accessibility tree, represented as YAML.
await page.GotoAsync("https://playwright.dev");
await Expect(page.Locator("body")).ToMatchAriaSnapshotAsync(@"
- banner:
- heading /Playwright enables reliable/ [level=1]
- link ""Get started""
- link ""Star microsoft/playwright on GitHub""
- main:
- img ""Browsers (Chromium, Firefox, WebKit)""
- heading ""Any browser ā¢ Any platform ā¢ One API""
");
You can generate this assertion with Test Generator or by calling [method: Locator.ariaSnapshot].
Learn more in the aria snapshots guide.
New method [method: Tracing.group] allows you to visually group actions in the trace viewer.
// All actions between GroupAsync and GroupEndAsync
// will be shown in the trace viewer as a group.
await Page.Context.Tracing.GroupAsync("Open Playwright.dev > API");
await Page.GotoAsync("https://playwright.dev/");
await Page.GetByRole(AriaRole.Link, new() { Name = "API" }).ClickAsync();
await Page.Context.Tracing.GroupEndAsync();
chrome and msedge channels switch to new headless modeThis change affects you if you're using one of the following channels in your playwright.config.ts:
chrome, chrome-dev, chrome-beta, or chrome-canarymsedge, msedge-dev, msedge-beta, or msedge-canaryAfter updating to Playwright v1.49, run your test suite. If it still passes, you're good to go. If not, you will probably need to update your snapshots, and adapt some of your test code around PDF viewers and extensions. See issue #33566 for more details.
You can opt into the new headless mode by using 'chromium' channel. As official Chrome documentation puts it:
New Headless on the other hand is the real Chrome browser, and is thus more authentic, reliable, and offers more features. This makes it more suitable for high-accuracy end-to-end web app testing or browser extension testing.
See issue #33566 for the list of possible breakages you could encounter and more details on Chromium headless. Please file an issue if you see any problems after opting in.
<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
<Playwright>
<BrowserName>chromium</BrowserName>
<LaunchOptions>
<Channel>chromium</Channel>
</LaunchOptions>
</Playwright>
</RunSettings>
dotnet test -- Playwright.BrowserName=chromium Playwright.LaunchOptions.Channel=chromium
<canvas> elements inside a snapshot now draw a preview.This version was also tested against the following stable channels:
New methods [method: Page.routeWebSocket] and [method: BrowserContext.routeWebSocket] allow to intercept, modify and mock WebSocket connections initiated in the page. Below is a simple example that mocks WebSocket communication by responding to a "request" with a "response".
await page.RouteWebSocketAsync("/ws", ws => {
ws.OnMessage(frame => {
if (frame.Text == "request")
ws.Send("response");
});
});
See [WebSocketRoute] for more details.
method: Route.fulfill] are not shown in the report and trace viewer anymore. You can see which network requests were routed in the network tab instead.method: Page.requestGC] may help detect memory leaks.This version was also tested against the following stable channels:
The Network tab in the trace viewer has several nice improvements:
mcr.microsoft.com/playwright/dotnet:v1.47.0 now serves a Playwright image based on Ubuntu 24.04 Noble.
To use the 22.04 jammy-based image, please use mcr.microsoft.com/playwright/dotnet:v1.47.0-jammy instead.:latest/:focal/:jammy tag for Playwright Docker images is no longer being published. Pin to a specific version for better stability and reproducibility.option: Browser.newContext.clientCertificates.cert] and [option: Browser.newContext.clientCertificates.key] as byte arrays instead of file paths.option: Locator.selectOption.noWaitAfter] in [method: Locator.selectOption] was deprecated.macos-13. We recommend upgrading GitHub Actions to macos-14.This version was also tested against the following stable channels:
Playwright now allows to supply client-side certificates, so that server can verify them, as specified by TLS Client Authentication.
You can provide client certificates as a parameter of [method: Browser.newContext] and [method: APIRequest.newContext]. The following snippet sets up a client certificate for https://example.com:
var context = await Browser.NewContextAsync(new() {
ClientCertificates = [
new() {
Origin = "https://example.com",
CertPath = "client-certificates/cert.pem",
KeyPath = "client-certificates/key.pem",
}
]
});
method: Route.continue].BaseURL.maxRetries option in [method: APIRequestContext.fetch] which retries on the ECONNRESET network error.This version was also tested against the following stable channels:
Utilizing the new [Clock] API allows to manipulate and control time within tests to verify time-related behavior. This API covers many common scenarios, including:
// Initialize clock with some time before the test time and let the page load naturally.
// `Date.now` will progress as the timers fire.
await Page.Clock.InstallAsync(new()
{
TimeDate = new DateTime(2024, 2, 2, 8, 0, 0)
});
await Page.GotoAsync("http://localhost:3333");
// Pretend that the user closed the laptop lid and opened it again at 10am.
// Pause the time once reached that point.
await Page.Clock.PauseAtAsync(new DateTime(2024, 2, 2, 10, 0, 0));
// Assert the page state.
await Expect(Page.GetByTestId("current-time")).ToHaveTextAsync("2/2/2024, 10:00:00 AM");
// Close the laptop lid again and open it at 10:30am.
await Page.Clock.FastForwardAsync("30:00");
await Expect(Page.GetByTestId("current-time")).ToHaveTextAsync("2/2/2024, 10:30:00 AM");
See the clock guide for more details.
Method [method: Locator.setInputFiles] now supports uploading a directory for <input type=file webkitdirectory> elements.
await page.GetByLabel("Upload directory").SetInputFilesAsync("mydir");
Multiple methods like [method: Locator.click] or [method: Locator.press] now support a ControlOrMeta modifier key. This key maps to Meta on macOS and maps to Control on Windows and Linux.
// Press the common keyboard shortcut Control+S or Meta+S to trigger a "Save" operation.
await page.Keyboard.PressAsync("ControlOrMeta+S");
New property httpCredentials.send in [method: APIRequest.newContext] that allows to either always send the Authorization header or only send it in response to 401 Unauthorized.
Playwright now supports Chromium, Firefox and WebKit on Ubuntu 24.04.
v1.45 is the last release to receive WebKit update for macOS 12 Monterey. Please update macOS to keep using the latest WebKit.
This version was also tested against the following stable channels:
Accessibility assertions
[method: LocatorAssertions.toHaveAccessibleName] checks if the element has the specified accessible name:
var locator = Page.GetByRole(AriaRole.Button);
await Expect(locator).ToHaveAccessibleNameAsync("Submit");
[method: LocatorAssertions.toHaveAccessibleDescription] checks if the element has the specified accessible description:
var locator = Page.GetByRole(AriaRole.Button);
await Expect(locator).ToHaveAccessibleDescriptionAsync("Upload a photo");
[method: LocatorAssertions.toHaveRole] checks if the element has the specified ARIA role:
var locator = Page.GetByTestId("save-button");
await Expect(locator).ToHaveRoleAsync(AriaRole.Button);
Locator handler
method: Page.addLocatorHandler], Playwright will now wait until the overlay that triggered the handler is not visible anymore. You can opt-out of this behavior with the new NoWaitAfter option.Times option in [method: Page.addLocatorHandler] to specify maximum number of times the handler should be run.method: Page.addLocatorHandler] now accepts the locator as argument.method: Page.removeLocatorHandler] method for removing previously added locator handlers.var locator = Page.GetByText("This interstitial covers the button");
await Page.AddLocatorHandlerAsync(locator, async (overlay) =>
{
await overlay.Locator("#close").ClickAsync();
}, new() { Times = 3, NoWaitAfter = true });
// Run your tests that can be interrupted by the overlay.
// ...
await Page.RemoveLocatorHandlerAsync(locator);
Miscellaneous options
New method [method: FormData.append] allows to specify repeating fields with the same name in Multipart option in APIRequestContext.FetchAsync():
var formData = Context.APIRequest.CreateFormData();
formData.Append("file", new FilePayload()
{
Name = "f1.js",
MimeType = "text/javascript",
Buffer = System.Text.Encoding.UTF8.GetBytes("var x = 2024;")
});
formData.Append("file", new FilePayload()
{
Name = "f2.txt",
MimeType = "text/plain",
Buffer = System.Text.Encoding.UTF8.GetBytes("hello")
});
var response = await Context.APIRequest.PostAsync("https://example.com/uploadFiles", new() { Multipart = formData });
[method: PageAssertions.toHaveURL] now supports IgnoreCase option.
This version was also tested against the following stable channels:
Method [method: BrowserContext.clearCookies] now supports filters to remove only some cookies.
// Clear all cookies.
await Context.ClearCookiesAsync();
// New: clear cookies with a particular name.
await Context.ClearCookiesAsync(new() { Name = "session-id" });
// New: clear cookies for a particular domain.
await Context.ClearCookiesAsync(new() { Domain = "my-origin.com" });
New property [method: Locator.contentFrame] converts a [Locator] object to a [FrameLocator]. This can be useful when you have a [Locator] object obtained somewhere, and later on would like to interact with the content inside the frame.
var locator = Page.Locator("iframe[name='embedded']");
// ...
var frameLocator = locator.ContentFrame;
await frameLocator.GetByRole(AriaRole.Button).ClickAsync();
New property [method: FrameLocator.owner] converts a [FrameLocator] object to a [Locator]. This can be useful when you have a [FrameLocator] object obtained somewhere, and later on would like to interact with the iframe element.
var frameLocator = page.FrameLocator("iframe[name='embedded']");
// ...
var locator = frameLocator.Owner;
await Expect(locator).ToBeVisibleAsync();
This version was also tested against the following stable channels:
New method [method: Page.addLocatorHandler] registers a callback that will be invoked when specified element becomes visible and may block Playwright actions. The callback can get rid of the overlay. Here is an example that closes a cookie dialog when it appears.
// Setup the handler.
await Page.AddLocatorHandlerAsync(
Page.GetByRole(AriaRole.Heading, new() { Name = "Hej! You are in control of your cookies." }),
async () =>
{
await Page.GetByRole(AriaRole.Button, new() { Name = "Accept all" }).ClickAsync();
});
// Write the test as usual.
await Page.GotoAsync("https://www.ikea.com/");
await Page.GetByRole(AriaRole.Link, new() { Name = "Collection of blue and white" }).ClickAsync();
await Expect(Page.GetByRole(AriaRole.Heading, new() { Name = "Light and easy" })).ToBeVisibleAsync();
method: Page.pdf] accepts two new options [option: Page.pdf.tagged] and [option: Page.pdf.outline].This version was also tested against the following stable channels:
method: Page.unrouteAll] removes all routes registered by [method: Page.route] and [method: Page.routeFromHAR]. Optionally allows to wait for ongoing routes to finish, or ignore any errors from them.method: BrowserContext.unrouteAll] removes all routes registered by [method: BrowserContext.route] and [method: BrowserContext.routeFromHAR]. Optionally allows to wait for ongoing routes to finish, or ignore any errors from them.option: Page.screenshot.style] in [method: Page.screenshot] and [option: Locator.screenshot.style] in [method: Locator.screenshot] to add custom CSS to the page before taking a screenshot.This version was also tested against the following stable channels:
New tools to generate assertions:
method: LocatorAssertions.toBeVisible].method: LocatorAssertions.toHaveValue].method: LocatorAssertions.toContainText].Here is an example of a generated test with assertions:
await Page.GotoAsync("https://playwright.dev/");
await Page.GetByRole(AriaRole.Link, new() { Name = "Get started" }).ClickAsync();
await Expect(Page.GetByLabel("Breadcrumbs").GetByRole(AriaRole.List)).ToContainTextAsync("Installation");
await Expect(Page.GetByLabel("Search")).ToBeVisibleAsync();
await Page.GetByLabel("Search").ClickAsync();
await Page.GetByPlaceholder("Search docs").FillAsync("locator");
await Expect(Page.GetByPlaceholder("Search docs")).ToHaveValueAsync("locator");
option: Page.close.reason] in [method: Page.close], [option: BrowserContext.close.reason] in [method: BrowserContext.close] and [option: Browser.close.reason] in [method: Browser.close]. Close reason is reported for all operations interrupted by the closure.option: BrowserType.launchPersistentContext.firefoxUserPrefs] in [method: BrowserType.launchPersistentContext].method: Download.path] and [method: Download.createReadStream] throw an error for failed and cancelled downloads.This version was also tested against the following stable channels:
Evergreen browsers update.
This version was also tested against the following stable channels:
event: BrowserContext.webError]method: Locator.pressSequentially]method: Page.type], [method: Frame.type],
[method: Locator.type] and [method: ElementHandle.type].
Please use [method: Locator.fill] instead which is much faster. Use
[method: Locator.pressSequentially] only if there is a special keyboard
handling on the page, and you need to press keys one-by-one.This version was also tested against the following stable channels:
Playwright now supports Debian 12 Bookworm on both x86_64 and arm64 for Chromium, Firefox and WebKit. Let us know if you encounter any issues!
Linux support looks like this:
| Ubuntu 20.04 | Ubuntu 22.04 | Debian 11 | Debian 12 | |
|---|---|---|---|---|
| Chromium | ā | ā | ā | ā |
| WebKit | ā | ā | ā | ā |
| Firefox | ā | ā | ā | ā |
This version was also tested against the following stable channels:
šļø Summer maintenance release.
This version was also tested against the following stable channels:
New option MaskColor for methods [method: Page.screenshot] and [method: Locator.screenshot] to change default masking color.
New uninstall CLI command to uninstall browser binaries:
$ pwsh bin/Debug/netX/playwright.ps1 uninstall # remove browsers installed by this installation
$ pwsh bin/Debug/netX/playwright.ps1 uninstall --all # remove all ever-install Playwright browsers
This version was also tested against the following stable channels:
New [method: Locator.and] to create a locator that matches both locators.
var button = page.GetByRole(AriaRole.BUTTON).And(page.GetByTitle("Subscribe"));
New events [event: BrowserContext.console] and [event: BrowserContext.dialog] to subscribe to any dialogs
and console messages from any page from the given browser context. Use the new methods [method: ConsoleMessage.page]
and [method: Dialog.page] to pin-point event source.
This version was also tested against the following stable channels:
Use [method: Locator.or] to create a locator that matches either of the two locators.
Consider a scenario where you'd like to click on a "New email" button, but sometimes a security settings dialog shows up instead.
In this case, you can wait for either a "New email" button, or a dialog and act accordingly:
var newEmail = Page.GetByRole(AriaRole.Button, new() { Name = "New email" });
var dialog = Page.GetByText("Confirm security settings");
await Expect(newEmail.Or(dialog)).ToBeVisibleAsync();
if (await dialog.IsVisibleAsync())
await Page.GetByRole(AriaRole.Button, new() { Name = "Dismiss" }).ClickAsync();
await newEmail.ClickAsync();
Use new options [option: Locator.filter.hasNot] and [option: Locator.filter.hasNotText] in [method: Locator.filter]
to find elements that do not match certain conditions.
var rowLocator = Page.Locator("tr");
await rowLocator
.Filter(new() { HasNotText = "text in column 1" })
.Filter(new() { HasNot = Page.GetByRole(AriaRole.Button, new() { Name = "column 2 button" })})
.ScreenshotAsync();
Use new web-first assertion [method: LocatorAssertions.toBeAttached] to ensure that the element
is present in the page's DOM. Do not confuse with the [method: LocatorAssertions.toBeVisible] that ensures that
element is both attached & visible.
method: Locator.or]option: Locator.filter.hasNot] in [method: Locator.filter]option: Locator.filter.hasNotText] in [method: Locator.filter]method: LocatorAssertions.toBeAttached]option: Route.fetch.timeout] in [method: Route.fetch]mcr.microsoft.com/playwright/dotnet:v1.33.0 now serves a Playwright image based on Ubuntu Jammy.
To use the focal-based image, please use mcr.microsoft.com/playwright/dotnet:v1.33.0-focal instead.This version was also tested against the following stable channels:
option: Page.routeFromHAR.updateMode] and [option: Page.routeFromHAR.updateContent] in [method: Page.routeFromHAR] and [method: BrowserContext.routeFromHAR].option: Tracing.startChunk.name] in method [method: Tracing.startChunk].This version was also tested against the following stable channels:
New assertion [method: LocatorAssertions.toBeInViewport] ensures that locator points to an element that intersects viewport, according to the intersection observer API.
var locator = Page.GetByRole(AriaRole.Button);
// Make sure at least some part of element intersects viewport.
await Expect(locator).ToBeInViewportAsync();
// Make sure element is fully outside of viewport.
await Expect(locator).Not.ToBeInViewportAsync();
// Make sure that at least half of the element intersects viewport.
await Expect(locator).ToBeInViewportAsync(new() { Ratio = 0.5 });
New methods [method: BrowserContext.newCDPSession] and [method: Browser.newBrowserCDPSession] create a Chrome DevTools Protocol session for the page and browser respectively.
option: Route.fetch.maxRedirects] for method [method: Route.fetch].This version was also tested against the following stable channels:
This version was also tested against the following stable channels:
New method [method: Route.fetch] and new option Json for [method: Route.fulfill]:
await Page.RouteAsync("**/api/settings", async route => {
// Fetch original settings.
var response = await route.FetchAsync();
// Force settings theme to a predefined value.
var json = await response.JsonAsync<MyDataType>();
json.Theme = "Solarized";
// Fulfill with modified data.
await route.FulfillAsync(new() {
Json = json
});
});
New method [method: Locator.all] to iterate over all matching elements:
// Check all checkboxes!
var checkboxes = Page.GetByRole(AriaRole.Checkbox);
foreach (var checkbox in await checkboxes.AllAsync())
await checkbox.CheckAsync();
[method: Locator.selectOption] matches now by value or label:
<select multiple>
<option value="red">Red</option>
<option value="green">Green</option>
<option value="blue">Blue</option>
</select>
await element.SelectOptionAsync("Red");
This version was also tested against the following stable channels:
method: Locator.blur]method: Locator.clear]This version was also tested against the following stable channels:
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.await page.GetByLabel("User Name").FillAsync("John");
await page.GetByLabel("Password").FillAsync("secret-password");
await page.GetByRole(AriaRole.Button, new() { NameString = "Sign in" }).ClickAsync();
await Expect(Page.GetByText("Welcome, John!")).ToBeVisibleAsync();
All the same methods are also available on [Locator], [FrameLocator] and [Frame] classes.
[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.
await Expect(Page.GetByRole(AriaRole.Button)).ToHaveAttributeAsync("disabled", "");
This version was also tested against the following stable channels:
Enabled for [method: LocatorAssertions.toBeEnabled].method: LocatorAssertions.toHaveText] now pierces open shadow roots.Editable for [method: LocatorAssertions.toBeEditable].Visible for [method: LocatorAssertions.toBeVisible].method: APIResponseAssertions.toBeOK] is now available.MaxRedirects for [method: APIRequestContext.get] and others to limit redirect count.A bunch of Playwright APIs already support the WaitUntil: WaitUntilState.DOMContentLoaded option.
For example:
await Page.GotoAsync("https://playwright.dev", new() { WaitUntil = 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 WaitUntil: WaitUntilState.Load to wait for all iframes.
This version was also tested against the following stable channels:
Microsoft.Playwright.NUnit and Microsoft.Playwright.MSTest will now consider the .runsettings file and passed settings via the CLI when running end-to-end tests. See in the documentation for a full list of supported settings.
The following does now work:
<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
<!-- Playwright -->
<Playwright>
<BrowserName>chromium</BrowserName>
<ExpectTimeout>5000</ExpectTimeout>
<LaunchOptions>
<Headless>true</Headless>
<Channel>msedge</Channel>
</LaunchOptions>
</Playwright>
<!-- General run configuration -->
<RunConfiguration>
<EnvironmentVariables>
<!-- For debugging selectors, it's recommend to set the following environment variable -->
<DEBUG>pw:api</DEBUG>
</EnvironmentVariables>
</RunConfiguration>
</RunSettings>
This version was also tested against the following stable channels:
<LiteYouTube id="9F05o1shxcY" title="Playwright 1.24" />
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 20.04 | Ubuntu 22.04 | Debian 11 | :--- | :---: | :---: | :---: | :---: | | Chromium | ā | ā | ā | | WebKit | ā | ā | ā | | Firefox | ā | ā | ā |
We rewrote our Getting Started docs to be more end-to-end testing focused. Check them out on playwright.dev.
Playwright for .NET 1.23 introduces new API Testing that lets you send requests to the server directly from .NET! Now you can:
To do a request on behalf of Playwright's Page, use new [property: Page.request] API:
// Do a GET request on behalf of page
var response = await Page.APIRequest.GetAsync("http://example.com/foo.json");
Console.WriteLine(response.Status);
Console.WriteLine(response.StatusText);
Console.WriteLine(response.Ok);
Console.WriteLine(response.Headers["Content-Type"]);
Console.WriteLine(await response.TextAsync());
Console.WriteLine((await response.JsonAsync())?.GetProperty("foo").GetString());
Read more about it in our API testing guide.
Now you can record network traffic into a HAR file and re-use this traffic in your tests.
To record network into HAR file:
pwsh bin/Debug/netX/playwright.ps1 open --save-har=example.har --save-har-glob="**/api/**" https://example.com
Alternatively, you can record HAR programmatically:
var context = await browser.NewContextAsync(new()
{
RecordHarPath = harPath,
RecordHarUrlFilterString = "**/api/**",
});
// ... Perform actions ...
// Close context to ensure HAR is saved to disk.
context.CloseAsync();
Use the new methods [method: Page.routeFromHAR] or [method: BrowserContext.routeFromHAR] to serve matching responses from the HAR file:
await context.RouteFromHARAsync("example.har");
Read more in our documentation.
You can now use [method: Route.fallback] to defer routing to other handlers.
Consider the following example:
// Remove a header from all requests.
await page.RouteAsync("**/*", async route =>
{
var headers = route.Request.Headers;
headers.Remove("X-Secret");
await route.ContinueAsync(new() { Headers = headers });
});
// Abort all images.
await page.RouteAsync("**/*", async route =>
{
if (route.Request.ResourceType == "image")
{
await route.AbortAsync();
}
else
{
await route.FallbackAsync();
}
});
Note that the new methods [method: Page.routeFromHAR] and [method: BrowserContext.routeFromHAR] also participate in routing and could be deferred to.
method: LocatorAssertions.toHaveValues] that asserts all selected values of <select multiple> element.method: LocatorAssertions.toContainText] and [method: LocatorAssertions.toHaveText] now accept ignoreCase option.serviceWorkers:
var context = await Browser.NewContextAsync(new()
{
ServiceWorkers = ServiceWorkerPolicy.Block
});
.zip path for recordHar context option automatically zips the resulting HAR:
var context = await Browser.NewContextAsync(new() { RecordHarPath = "example.har.zip" });
"minimal" HAR recording mode
that only records information that is essential for replaying:
var context = await Browser.NewContextAsync(new() { RecordHarPath = "example.har", RecordHarMode = HarMode.Minimal });
Role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.
// Click a button with accessible name "log in"
await page.Locator("role=button[name='log in']").ClickAsync();
Read more in our documentation.
New [method: Locator.filter] API to filter an existing locator
var buttons = page.Locator("role=button");
// ...
var submitLocator = buttons.Filter(new() { HasText = "Sign up" });
await submitLocator.ClickAsync();
New role selectors that allow selecting elements by their ARIA role, ARIA attributes and accessible name.
// Click a button with accessible name "log in"
await page.Locator("role=button[name='log in']").ClickAsync();
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".
We now ship a designated .NET docker image mcr.microsoft.com/playwright/dotnet. Read more in our documentation.
method: Locator.setInputFiles] API.This version was also tested against the following stable channels:
Playwright for .NET 1.20 introduces Web-First Assertions.
Consider the following example:
using System.Threading.Tasks;
using Microsoft.Playwright.NUnit;
using NUnit.Framework;
namespace PlaywrightTests;
[TestFixture]
public class ExampleTests : PageTest
{
[Test]
public async Task StatusBecomesSubmitted()
{
await Expect(Page.Locator(".status")).ToHaveTextAsync("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.
Read more in our documentation.
method: Page.screenshot], [method: Locator.screenshot] and [method: ElementHandle.screenshot]:
ScreenshotAnimations.Disabled rewinds all CSS animations and transitions to a consistent statemask: Locator[] masks given elements, overlaying them with pink #FF00FF boxes.method: Locator.highlight] visually reveals element(s) for easier debugging.This version was also tested against the following stable channels:
Locator now supports a has option that makes sure it contains another locator inside:
await Page.Locator("article", new() { Has = Page.Locator(".highlight") }).ClickAsync();
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
This version was also tested against the following stable channels:
method: Locator.dragTo]await Page.Locator("li", new() { HasTextString = "My Item" })
.Locator("button").click();
AcceptDownloads option now defaults to true.Sources option to embed sources into traces.This version was also tested against the following stable channels:
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.
var locator = page.FrameLocator("#my-frame").Locator("text=Submit");
await locator.ClickAsync();
Read more at our documentation.
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.
pwsh bin/Debug/netX/playwright.ps1 install msedge
Wait for a locator to resolve to a single element with a given state.
Defaults to the state: 'visible'.
var orderSent = page.Locator("#order-sent");
orderSent.WaitForAsync();
Read more about [method: Locator.waitFor].
pwsh bin/Debug/netX/playwright.ps1 show-trace and drop trace files to the trace viewer PWARead more about Trace Viewer.
This version of Playwright was also tested against the following stable channels:
By using [method: Mouse.wheel] you are now able to scroll vertically or horizontally.
Previously it was not possible to get multiple header values of a response. This is now possible and additional helper functions are available:
method: Request.allHeaders]method: Request.headersArray]method: Request.headerValue]method: Response.allHeaders]method: Response.headersArray]method: Response.headerValue]method: Response.headerValues]Its now possible to emulate the forced-colors CSS media feature by passing it in the [method: Browser.newContext] or calling [method: Page.emulateMedia].
method: Page.route] accepts new times option to specify how many times this route should be matched.method: Page.setChecked] and [method: Locator.setChecked] were introduced to set the checked state of a checkbox.method: Request.sizes] Returns resource size information for given http request.method: Tracing.startChunk] - Start a new trace chunk.method: Tracing.stopChunk] - Stops a new trace chunk.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!
await page.Locator("button", new() { Strict = true });
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!
var locator = page.Locator("button");
await locator.ClickAsync();
Learn more in the documentation.
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.
await page.Locator("_react=SubmitButton[enabled=true]").ClickAsync();
await page.Locator("_vue=submit-button[enabled=true]").ClickAsync();
Learn more in the react selectors documentation and the vue selectors documentation.
nth and visible selector enginesnth 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
await button.ClickAsync("button >> nth=0");
// or if you are using locators, you can use First, Nth() and Last
await page.Locator("button").First.ClickAsync();
// click a visible button
await button.ClickAsync("button >> visible=true");
method: Page.dragAndDrop] API.recordHar option in [method: Browser.newContext].console.log() calls.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]force option in [method: Page.fill], [method: Frame.fill], and [method: ElementHandle.fill]force option in [method: Page.selectOption], [method: Frame.selectOption], and [method: ElementHandle.selectOption]This version of Playwright was also tested against the following stable channels: