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 1f20b0470c
chore: run docker tests on every commit (#9632)
Otherwise, we run docker tests very rarely, and their failures don't
show up on the flakiness dashboard.
2021-10-20 11:53:28 +02:00
.devcontainer chore: fixed devcontainer Docker usage (#3898) 2020-09-17 11:21:10 -07:00
.github chore: run docker tests on every commit (#9632) 2021-10-20 11:53:28 +02:00
browser_patches Revert adding depot_tools (#9645) 2021-10-20 11:00:26 +02:00
docs docs(expect): group locator methods, remove extra > (#9625) 2021-10-19 13:54:26 -07:00
installation-tests test: dont test for the errors file because we no longer export it (#9628) 2021-10-19 16:39:11 -07:00
packages chore: speed up snippet generation 50 times (#9638) 2021-10-19 21:10:14 -07:00
tests tests: skip Docker ipv6 tests (#9646) 2021-10-20 02:03:46 -07:00
utils chore: fix //utils/print_versions.js (#9647) 2021-10-20 02:20:46 -07:00
.editorconfig Initial commit 2019-11-19 10:58:15 -08:00
.eslintignore chore: migrate to monorepo (#9421) 2021-10-11 16:52:17 +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 chore: remove internal uses of "folio" (#6931) 2021-06-06 22:07:07 -07:00
install-from-github.js fix(monorepo): explicitly list package.json exports instead of using glob patterns (#9584) 2021-10-19 12:28:02 -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 fix(monorepo): support yarn2/pnp by specifying all deps and bins (#9620) 2021-10-19 14:49:47 -04:00
package.json Reland chore: update to webpack v5.58.2 (#9498) 2021-10-14 17:36:59 +02:00
README.md docs: Page screenshot Example with all TypeScript types (#9549) 2021-10-18 16:08:18 -07:00
SECURITY.md Revert "chore: rework the crlf in md fix" 2021-01-20 15:45:59 -08:00
tsconfig.json chore(create-playwright): nits and cleanups (#9537) 2021-10-15 16:39:12 +02: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.4666.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
  page.route('**', route => {
    console.log(route.request().url());
    route.continue();
  });

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

Resources