Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
Go to file
2020-05-03 11:23:19 -07:00
.circleci devops: add package-lock.json (#1859) (#1889) 2020-04-20 16:57:01 -07:00
.github devops: run install tests on common node versions (#2069) 2020-05-01 00:10:52 -07:00
browser_patches chore: bump webkit build to kick bots 2020-05-01 12:11:40 -07:00
docs docs: add anchors for toc topics 2020-05-03 11:23:19 -07:00
packages chore: cut v0.16.0 (#2065) 2020-04-30 17:41:03 -07:00
src fix(webkit): make click work with cross-process _blank target (#2083) 2020-05-02 10:57:33 -07:00
test fix(webkit): make click work with cross-process _blank target (#2083) 2020-05-02 10:57:33 -07:00
utils feat(testrunner): improvements to testrunner (#2070) 2020-05-01 10:09:45 -07:00
.appveyor.yml devops: add package-lock.json (#1859) (#1889) 2020-04-20 16:57:01 -07:00
.cirrus.yml chore: windows bots via github actions (#678) 2020-01-28 18:04:51 -08:00
.editorconfig Initial commit 2019-11-19 10:58:15 -08:00
.eslintignore types: better types (#1166) 2020-03-20 01:30:35 -07:00
.eslintrc.js chore(lint): add @typescript-eslint/no-unnecessary-type-assertion rule (#898) 2020-02-07 13:38:50 -08:00
.gitattributes chore: windows bots via github actions (#678) 2020-01-28 18:04:51 -08:00
.gitignore chore: simplify and restructure downloads (#1974) 2020-04-24 19:14:10 -07:00
.npmignore chore: remove uncompiled download-browser (#2018) 2020-04-28 17:06:01 -07:00
.travis.yml devops: attempt to add mac 10.14 (#2076) 2020-05-01 14:03:09 -07:00
browsers.json browser(webkit): roll webkit to 1213 (#2045) 2020-04-29 18:40:18 -07:00
CODE_OF_CONDUCT.md Initial CODE_OF_CONDUCT.md commit 2019-11-15 10:32:47 -08:00
CONTRIBUTING.md docs(contributing): clean up headings 2020-04-23 16:23:58 -07:00
index.d.ts types: better types (#1166) 2020-03-20 01:30:35 -07:00
index.js chore: remove uncompiled download-browser (#2018) 2020-04-28 17:06:01 -07:00
install-from-github.js feat(registry): implement download registry (#1979) 2020-04-29 17:19:21 -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 fix(chromium): do not wait forever for navigations that target another tab/download (#2068) 2020-04-30 21:24:03 -07:00
package.json chore: cut v0.16.0 (#2065) 2020-04-30 17:41:03 -07:00
README.md feat(chromium): roll to r763809 (#2028) 2020-04-29 08:44:09 -07:00
SECURITY.md Initial SECURITY.md commit 2019-11-15 10:32:49 -08:00
tsconfig.json types: better types (#1166) 2020-03-20 01:30:35 -07:00

🎭 Playwright

npm version Join Slack Chromium version Firefox version WebKit version

Docs | API reference | Changelog

Playwright is a Node 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 84.0.4131.0
WebKit 13.0.4
Firefox 76.0b5

Headless execution is supported for all the browsers on all platforms.

Usage

npm i 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
  • 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,
    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