Playwright for .NET 🎭

Playwright for .NET is the official language port of Playwright, a Node.js based library to automate Chromium, Firefox and WebKit with a single API. Playwright is built to enable cross-browser web automation that is ever-green, capable, reliable and fast.

• Website: https://playwright.dev/dotnet
• .NET API Reference: https://playwright.dev/dotnet/docs/api/class-playwright Note: 🚧🏗 we're still working on this, so it might not be 100% up to date
• Getting Started: https://playwright.dev/dotnet/docs/intro

Getting Started

To get started with Playwright, you need to have Microsoft.Playwright.CLI global dotnet tool install. You only need to do this once.

dotnet tool install --global Microsoft.Playwright.CLI

Install the Microsoft.Playwright package from NuGet in Visual Studio, or directly from the CLI in your project root directory:

dotnet add package Microsoft.Playwright
dotnet build
playwright install

The last command invokes the global tool you've installed earlier, to install the browsers needed for Playwright to work.

Create a Program.cs that navigates to https://playwright.dev/dotnet and takes a screenshot in Chromium.

using System.Threading.Tasks;
using Microsoft.Playwright;

class Program
{
    public static async Task Main()
    {
        using var playwright = await Playwright.CreateAsync();
        await using var browser = await playwright.Chromium.LaunchAsync(new() { Headless = false });
        var page = await browser.NewPageAsync();
        await page.GotoAsync("https://playwright.dev/dotnet");
        await page.ScreenshotAsync(new PageScreenshotOptions() { Path = "screenshot.png" });
    }
}

Run it using dotnet run or other preferred method.

Dependencies

The .NET port relies on two external components, Playwright itself, and the browsers. Because Playwright is a Node.js library, required assemblies (including node) are downloaded and added to the bin folder.

Playwright Driver

Playwright drivers will be copied to the bin folder at build time. Nuget will rely on the RuntimeIdentifier to copy a platform-specific driver, or on the runtime used on dotnet publish. If the RuntimeIdentifier is not set, all runtimes will be copied inside a runtimes folder. Then, the platform-specific driver will be picked at run-time.

Browsers

For most scenarios, browsers are installed automatically. See this upstream documentation for more information.

Note: we're still working on some changes, and we'll update the Readme as we continue. For now, stuff like remote connect is not documented.

If none of the scenarios mentioned above cover your scenario, you can install the browsers programmatically using await Playwright.InstallAsync();

Capabilities

Playwright is built to automate the broad and growing set of web browser capabilities used by Single Page Apps and Progressive Web Apps.

• Scenarios that span multiple page, domains and iframes
• Auto-wait for elements to be ready before executing actions (like click, fill)
• Intercept network activity for stubbing and mocking network requests
• Emulate mobile devices, geolocation, permissions
• Support for web components via shadow-piercing selectors
• Native input events for mouse and keyboard
• Upload and download files

Examples

Mobile and geolocation

This snippet emulates Mobile Safari on a device at a given geolocation, navigates to Bing Maps, performs an action, and takes a screenshot.

using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Webkit.LaunchAsync(new BrowserTypeLaunchOptions() { Headless = false });

var context = await browser.NewContextAsync(new BrowserNewContextOptions()
{
    IsMobile = true,
    Locale = "en-US",
    Geolocation = new Geolocation { Longitude = 12.492507f, Latitude = 41.889938f },
    Permissions = new[] { "geolocation" }
});

var page = await context.NewPageAsync();
await page.GotoAsync("https://www.bing.com/maps");

await page.ClickAsync(".bnp_btn_accept");
await page.ClickAsync("#LocateMeButton");
await page.WaitForLoadStateAsync(LoadState.NetworkIdle);

await page.ScreenshotAsync(new PageScreenshotOptions() { Path = "colosseum-iphone.png" });

Evaluate in browser context

This code snippet navigates to bing.com in Firefox and executes a script in the page context. This also demonstrates how to interact with the javascript context and get values from it, converting them (where possible) to .NET objects (i.e. Rect in our example).

using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Firefox.LaunchAsync();

var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await page.GotoAsync("https://www.bing.com/");
var dimensions = await page.EvaluateAsync<Size>(@"() => {
return {
    width: document.documentElement.clientWidth,
    height: document.documentElement.clientHeight,
}}");
Console.WriteLine($"Dimensions: {dimensions.Width} x {dimensions.Height}");

Intercept network requests

This code snippet sets up request routing for a WebKit page to log all network requests.

using var playwright = await Playwright.CreateAsync();
await using var browser = await playwright.Firefox.LaunchAsync();

var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
// Log and continue all network requests
await page.RouteAsync("**", (route) =>
{
    Console.WriteLine($"Route intercepted: ${route.Request.Url}");
    route.ContinueAsync();
});

await page.GotoAsync("http://todomvc.com");

CLI & Codegen

Playwright conveniently comes with a built-in codegen facility which lets you open an inspector and a browser window, then record the actions you perform, generating the relevant source code as you do.

To use it, you need to install the dotnet tool:

dotnet tool install --global microsoft.playwright.cli

Then, you can simply call:

playwright codegen https://www.microsoft.com

Resources

• Documentation
• API reference
• Community showcase
• Contribution guide
• Changelog

Browser Support/Current Versions

Headless execution is supported for all browsers on all platforms.