Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
Go to file
2021-04-20 16:55:35 -07:00
.devcontainer chore: fixed devcontainer Docker usage (#3898) 2020-09-17 11:21:10 -07:00
.github feat: start downloading firefox-stable channel (#6177) 2021-04-19 21:26:33 -07:00
.storybook feat(ui): extract recorder sidebar into a window (#5223) 2021-01-31 16:37:13 -08:00
bin chore(adb): make driver smaller (#4713) 2020-12-14 18:39:14 -08:00
browser_patches devops: fix firefox-stable roll build (#6255) 2021-04-20 16:55:35 -07:00
docs feat(debug): PWDEBUG=console vs PWDEBUG=inspector (#6213) 2021-04-20 15:58:34 -07:00
packages fix: host dependency validation (#6227) 2021-04-20 18:54:53 +02:00
src feat(debug): PWDEBUG=console vs PWDEBUG=inspector (#6213) 2021-04-20 15:58:34 -07:00
tests feat: start downloading firefox-stable channel (#6177) 2021-04-19 21:26:33 -07:00
types feat(waitForEvent): allow async predicate (#6201) 2021-04-19 10:32:51 -07:00
utils chore(dotnet): generate IDownload.createReadStream method (#6192) 2021-04-19 13:28:57 -07:00
.editorconfig Initial commit 2019-11-19 10:58:15 -08:00
.eslintignore test: bring new folio and migrate small amount of tests to it (#5994) 2021-04-01 16:35:26 -07:00
.eslintrc.js feat(cli): bring in trace viewer (#4920) 2021-01-07 16:15:34 -08:00
.gitattributes chore: remove the .gitattributes entries for md/yml 2021-01-20 15:43:20 -08:00
.gitignore test: move remaining files from old test/ directory (#6081) 2021-04-05 15:51:45 -07:00
browsers.json feat: start downloading firefox-stable channel (#6177) 2021-04-19 21:26:33 -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: replace headful with headed (#6017) 2021-04-01 11:13:50 -07:00
index.d.ts feat(types): make the template on BrowserType optional (#6142) 2021-04-08 10:27:24 -07:00
index.js feat(inspector): render errors (#5459) 2021-02-13 22:13:51 -08:00
install-from-github.js fix: installer compilation (#5908) 2021-03-22 17:39:03 -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 test: roll to folio 0.3.21-alpha (#6108) 2021-04-06 16:09:54 -07:00
package.json test: cleanup various testing env variables (#6155) 2021-04-09 07:59:09 -07:00
README.md feat(chromium): roll to r869727 (#6170) 2021-04-09 20:57:41 -07:00
SECURITY.md Revert "chore: rework the crlf in md fix" 2021-01-20 15:45:59 -08:00
tsconfig.json feat: add replay log (#5452) 2021-02-12 18:53:46 -08: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 91.0.4469.0
WebKit 14.2
Firefox 88.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