Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
Go to file
2022-01-26 13:31:48 -08:00
.devcontainer chore: fixed devcontainer Docker usage (#3898) 2020-09-17 11:21:10 -07:00
.github fix(prepare): don't change package files on prepare (#11579) 2022-01-24 11:25:24 -08:00
browser_patches browser(webkit): handle ctr+click on linux (#11636) 2022-01-26 08:32:22 -08:00
docs docs: fix intro example (#11658) 2022-01-26 13:31:48 -08:00
examples examples: add a couple of @playwright/test examples (#10758) 2021-12-07 12:35:38 -08:00
installation-tests fix: default list reporter should dump stderr to stderr (#11351) 2022-01-12 07:43:25 -08:00
packages fix(server): handle = in cookie values correctly (#11613) 2022-01-26 11:27:43 -08:00
tests test: enable filechooser test in chromium (#11653) 2022-01-26 12:39:59 -08:00
utils fix(prepare): don't change package files on prepare (#11579) 2022-01-24 11:25:24 -08:00
.editorconfig Initial commit 2019-11-19 10:58:15 -08:00
.eslintignore feat(create-playwright): add option to add examples (#8963) 2021-10-21 20:21:50 +02:00
.eslintrc.js chore: enable object-curly-spacing in ESLint (#9168) 2021-09-27 18:58:08 +02:00
.gitattributes chore: lang hint for GitHub 2021-12-13 04:05:17 -08:00
.gitignore docs(python): enable web-first assertions (#10390) 2021-11-18 00:46:30 +01: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 devops: migrate from master to main branch (#10303) 2021-12-07 22:58:33 -08: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 docs: commit release notes for 1.18 (#11396) 2022-01-14 03:56:34 -08:00
package.json fix(prepare): don't change package files on prepare (#11579) 2022-01-24 11:25:24 -08:00
README.md feat(chromium): roll to r960211 (#11487) 2022-01-24 08:40:45 -08:00
SECURITY.md Revert "chore: rework the crlf in md fix" 2021-01-20 15:45:59 -08:00
tsconfig.json chore: remove create-playwright, it is in monorepo by mistake (#10654) 2021-12-01 13:09:35 -08:00

🎭 Playwright

npm version Chromium version Firefox version WebKit version

Documentation | API reference

Playwright is a framework for Web Testing and Automation. It allows testing 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 99.0.4837.0
WebKit 15.4
Firefox 96.0.1

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 and saves a screenshot.

import { test } from '@playwright/test';

test('Page Screenshot', async ({ page }) => {
    await page.goto('http://whatsmyuseragent.org/');
    await page.screenshot({ path: `example.png` });
});

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.

import { test, devices } from '@playwright/test';

test.use({
  ...devices['iPhone 13 Pro'],
  locale: 'en-US',
  geolocation: { longitude: 12.492507, latitude: 41.889938 },
  permissions: ['geolocation'],
})

test('Mobile and geolocation', async ({ page }) => {
  await page.goto('https://maps.google.com');
  await page.locator('text="Your location"').click();
  await page.waitForRequest(/.*preview\/pwa/);
  await page.screenshot({ path: 'colosseum-iphone.png' });
});

Evaluate in browser context

This code snippet navigates to example.com, and executes a script in the page context.

import { test } from '@playwright/test';

test('Evaluate in browser context', async ({ page }) => {
  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);
});

Intercept network requests

This code snippet sets up request routing for a page to log all network requests.

import { test } from '@playwright/test';

test('Intercept network requests', async ({ page }) => {
  // Log and continue all network requests
  await page.route('**', route => {
    console.log(route.request().url());
    route.continue();
  });
  await page.goto('http://todomvc.com');
});

Resources