Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
Go to file
2021-10-29 19:32:56 +02:00
.devcontainer chore: fixed devcontainer Docker usage (#3898) 2020-09-17 11:21:10 -07:00
.github devops: build canary docker daily 2021-10-27 16:37:46 -07:00
browser_patches browser(webkit): Page.setComposition (#9765) 2021-10-29 10:48:37 -04:00
docs docs: clarify how to import assertions (#9868) 2021-10-29 08:33:07 -07:00
installation-tests chore: sort out base fixtures (#9809) 2021-10-27 08:28:53 -07:00
packages chore: migrate away from ps1 in install-deps on Windows (#9876) 2021-10-29 19:32:56 +02:00
tests fix(matchers): support builtin types (#9865) 2021-10-28 18:45:59 -07:00
utils fix(devops): do not upload -win32.zip to Azure (#9884) 2021-10-29 09:54:04 -07:00
.editorconfig Initial commit 2019-11-19 10:58:15 -08:00
.eslintignore feat(create-playwright): add option to add examples (#8963) 2021-10-21 20:21:50 +02:00
.eslintrc.js chore: enable object-curly-spacing in ESLint (#9168) 2021-09-27 18:58:08 +02:00
.gitattributes chore: remove the .gitattributes entries for md/yml 2021-01-20 15:43:20 -08:00
.gitignore chore: migrate to monorepo (#9421) 2021-10-11 16:52:17 +02:00
babel.config.json chore: don't include babel compiled files in webpack bundles (#9491) 2021-10-13 19:27:50 -07:00
CODE_OF_CONDUCT.md Revert "chore: rework the crlf in md fix" 2021-01-20 15:45:59 -08:00
CONTRIBUTING.md docs: fix some English in CONTRIBUTING.md (#9641) 2021-10-21 08:29:12 -04:00
install-from-github.js fix: support even older node 12 (#9718) 2021-10-22 15:59:52 -04:00
LICENSE chore(license): use Apache 2.0 (#389) 2020-01-06 18:22:35 -08:00
NOTICE chore(license): add NOTICE (#309) 2019-12-19 12:19:54 -08:00
package-lock.json chore: pin expect package (#9713) 2021-10-22 08:07:33 -07:00
package.json chore: drop basetest from package.json (#9843) 2021-10-28 02:15:39 -07:00
README.md feat(chromium): roll to r934379 (#9793) 2021-10-27 12:39:57 +02:00
SECURITY.md Revert "chore: rework the crlf in md fix" 2021-01-20 15:45:59 -08:00
tsconfig.json fix: support even older node 12 (#9718) 2021-10-22 15:59:52 -04:00

🎭 Playwright

npm version Join Slack Chromium version Firefox version WebKit version

Documentation | API reference

Playwright is a Node.js 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.

Linux macOS Windows
Chromium 97.0.4681.0
WebKit 15.4
Firefox 93.0

Headless execution is supported for all the browsers on all platforms. Check out system requirements for details.

Usage

npm i -D playwright

This installs Playwright and browser binaries for Chromium, Firefox and WebKit. Once installed, you can require Playwright in a Node.js script and automate web browser interactions.

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

Page screenshot

This code snippet navigates to whatsmyuseragent.org in Chromium, Firefox and WebKit, and saves 3 screenshots.

const playwright = require('playwright');

(async () => {
  for (const browserType of [playwright.chromium, playwright.firefox, playwright.webkit]) {
    const browser = await browserType.launch();
    const context = await browser.newContext();
    const page = await context.newPage();
    await page.goto('http://whatsmyuseragent.org/');
    await page.screenshot({ path: `example-${browserType.name()}.png` });
    await browser.close();
  }
})();

Mobile and geolocation

This snippet emulates Mobile Safari on a device at a given geolocation, navigates to maps.google.com, performs action and takes a screenshot.

const { webkit, devices } = require('playwright');
const iPhone11 = devices['iPhone 11 Pro'];

(async () => {
  const browser = await webkit.launch();
  const context = await browser.newContext({
    ...iPhone11,
    locale: 'en-US',
    geolocation: { longitude: 12.492507, latitude: 41.889938 },
    permissions: ['geolocation']
  });
  const page = await context.newPage();
  await page.goto('https://maps.google.com');
  await page.click('text="Your location"');
  await page.waitForRequest(/.*preview\/pwa/);
  await page.screenshot({ path: 'colosseum-iphone.png' });
  await browser.close();
})();

Evaluate in browser context

This code snippet navigates to example.com in Firefox, and executes a script in the page context.

const { firefox } = require('playwright');

(async () => {
  const browser = await firefox.launch();
  const context = await browser.newContext();
  const page = await context.newPage();
  await page.goto('https://www.example.com/');
  const dimensions = await page.evaluate(() => {
    return {
      width: document.documentElement.clientWidth,
      height: document.documentElement.clientHeight,
      deviceScaleFactor: window.devicePixelRatio
    }
  });
  console.log(dimensions);

  await browser.close();
})();

Intercept network requests

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

const { webkit } = require('playwright');

(async () => {
  const browser = await webkit.launch();
  const context = await browser.newContext();
  const page = await context.newPage();

  // Log and continue all network requests
  await page.route('**', route => {
    console.log(route.request().url());
    route.continue();
  });

  await page.goto('http://todomvc.com');
  await browser.close();
})();

Resources