Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
Go to file
Andrey Lushnikov 7caef6f09f
browser(chromium): attempt to do another build of Chromium (#8035)
Previous build of chromium was crashing in 10% of tests. We might've
picked up a bad revision to build, so trying to build a newer one.
2021-08-06 04:56:29 -07:00
.devcontainer chore: fixed devcontainer Docker usage (#3898) 2020-09-17 11:21:10 -07:00
.github chore: move msedge-dev workflow to secondary tests (#7681) 2021-07-16 21:40:13 +02:00
bin fix: do not assume basic tools on linux when intalling channels (#7793) 2021-07-22 07:58:01 -07:00
browser_patches browser(chromium): attempt to do another build of Chromium (#8035) 2021-08-06 04:56:29 -07:00
docs docs: add android requirements to the api docs page (#8014) 2021-08-05 21:12:34 -07:00
packages feat(test-runner): rename Test to TestCase (#7725) 2021-07-19 14:54:18 -07:00
src fix(trace viewer): render snapshots with correct viewport size (#8020) 2021-08-05 16:04:09 -07:00
tests fix(trace viewer): render snapshots with correct viewport size (#8020) 2021-08-05 16:04:09 -07:00
types docs: add android requirements to the api docs page (#8014) 2021-08-05 21:12:34 -07:00
utils feat(test-runner): basic html reporter (#7994) 2021-08-05 13:36:47 -07:00
.babelrc chore(typescript): update to 4.3 (#7809) 2021-08-03 12:21:07 -04:00
.editorconfig Initial commit 2019-11-19 10:58:15 -08:00
.eslintignore chore(typescript): compile with babel, lint everything with tsc (#6872) 2021-06-23 18:01:48 -07:00
.eslintrc.js chore: update eslint config (#6840) 2021-06-02 08:41:48 -07:00
.gitattributes chore: remove the .gitattributes entries for md/yml 2021-01-20 15:43:20 -08:00
.gitignore feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00
browsers.json feat(firefox-beta): roll to 1273 (#7986) 2021-08-05 01:00:00 +02:00
CODE_OF_CONDUCT.md Revert "chore: rework the crlf in md fix" 2021-01-20 15:45:59 -08:00
CONTRIBUTING.md chore: remove internal uses of "folio" (#6931) 2021-06-06 22:07:07 -07:00
index.d.ts types: move exported objects from index.d.ts to overrides.d.ts (#7152) 2021-06-15 15:06:18 -07:00
index.js feat(inspector): render errors (#5459) 2021-02-13 22:13:51 -08:00
install-from-github.js chore: move install to Registry (#7433) 2021-07-06 20:59:16 -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 feat(test-runner): basic html reporter (#7994) 2021-08-05 13:36:47 -07:00
package.json feat(test-runner): basic html reporter (#7994) 2021-08-05 13:36:47 -07:00
README.md feat(chromium): roll Chromium to another new version (#7676) 2021-07-16 09:03:42 -07:00
SECURITY.md Revert "chore: rework the crlf in md fix" 2021-01-20 15:45:59 -08:00
tsconfig.json chore(typescript): compile with babel, lint everything with tsc (#6872) 2021-06-23 18:01:48 -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 93.0.4576.0
WebKit 14.2
Firefox 90.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 ['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