Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
Go to file
2020-08-28 15:45:09 -07:00
.github fix(trace): only enable on separate tracing bots (#3677) 2020-08-28 13:50:06 -07:00
bin feat(launcher): check dependencies before launch on Windows (#3240) 2020-07-30 17:15:46 -07:00
browser_patches browser(webkit): use webkit generate-bundle tool to generate the bundles (#3563) 2020-08-28 10:48:57 -07:00
docs docs(docker): add link to mcr status ui (#3679) 2020-08-28 14:30:51 -07:00
packages enh: bake browser revisions and api into driver (#3514) 2020-08-26 16:01:42 -07:00
src fix: support IP:PORT short notation to specify proxy server (#3568) 2020-08-28 14:17:16 -07:00
test feat(test): use metafunc in describes (#3682) 2020-08-28 15:45:09 -07:00
test-runner feat(test): use metafunc in describes (#3682) 2020-08-28 15:45:09 -07:00
utils fix(trace): only enable on separate tracing bots (#3677) 2020-08-28 13:50:06 -07:00
.editorconfig Initial commit 2019-11-19 10:58:15 -08:00
.eslintignore chore: bump dev dependencies (#3659) 2020-08-28 13:43:57 -07:00
.eslintrc.js chore(testrunner): introduce test result, reuse it in ipc (#3644) 2020-08-26 14:14:23 -07:00
.gitattributes chore: windows bots via github actions (#678) 2020-01-28 18:04:51 -08:00
.gitignore fix(testrunner): pass error into test fixtures (#3605) 2020-08-24 14:55:48 -07:00
browsers.json feat(webkit): bump to 1334 (#3643) 2020-08-26 15:18:39 -07:00
CODE_OF_CONDUCT.md Initial CODE_OF_CONDUCT.md commit 2019-11-15 10:32:47 -08:00
CONTRIBUTING.md docs(CONTRIBUTING.md): Add build step (#2869) 2020-07-07 22:38:59 -07:00
electron-types.d.ts chore(test): move electron tests to typescript (#3379) 2020-08-10 23:04:38 -07:00
index.d.ts types: better types (#1166) 2020-03-20 01:30:35 -07:00
index.js test: always setUnderTest in index.js, rename to setDevMode (#3662) 2020-08-27 21:08:33 -07:00
install-from-github.js chore: generate protocol during browser roll (#2719) 2020-07-01 15:22:29 -07: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: bump dev dependencies (#3659) 2020-08-28 13:43:57 -07:00
package.json chore: bump dev dependencies (#3659) 2020-08-28 13:43:57 -07:00
README.md feat(firefox): roll firefox to r1160 (#3468) 2020-08-15 17:15:21 -07:00
SECURITY.md Initial SECURITY.md commit 2019-11-15 10:32:49 -08:00
tsconfig.json fix(css selector): support comma-separated selector lists (#2120) 2020-05-07 13:36:54 -07: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 86.0.4217.0
WebKit 14.0
Firefox 80.0b8

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 ['chromium', 'firefox', 'webkit']) {
    const browser = await playwright[browserType].launch();
    const context = await browser.newContext();
    const page = await context.newPage();
    await page.goto('http://whatsmyuseragent.org/');
    await page.screenshot({ path: `example-${browserType}.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
  page.route('**', route => {
    console.log(route.request().url());
    route.continue();
  });

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

Resources