Use npm or Yarn to install Playwright in your Node.js project. See system requirements.
This single command downloads the Playwright NPM package and browser binaries for Chromium, Firefox and WebKit. To modify this behavior see installation parameters.
Once installed, you can
require Playwright in a Node.js script, and launch any of the 3 browsers (
Playwright APIs are asynchronous and return Promise objects. Our code examples use the async/await pattern to ease readability. The code is wrapped in an unnamed async arrow function which is invoking itself.
In our first script, we will navigate to
whatsmyuseragent.org and take a screenshot in WebKit.
By default, Playwright runs the browsers in headless mode. To see the browser UI, pass the
headless: false flag while launching the browser. You can also use
slowMo to slow down execution.
Playwright includes built-in support for TypeScript. Type definitions will be imported automatically. It is recommended to use type-checking to improve the IDE experience.
Alternatively, you can use JSDoc to set types for variables.
TypeScript support will work out-of-the-box. Types can also be imported explicitly.
Playwright requires Node.js version 10.17 or above. The browser binaries for Chromium, Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
- Windows: Works with Windows and Windows Subsystem for Linux (WSL).
- macOS: Requires 10.14 or above.
- Linux: Depending on your Linux distribution, you might need to install additional
dependencies to run the browsers.
- Firefox requires Ubuntu 18.04+
- For Ubuntu 18.04, the additional dependencies are defined in our Docker image, which is based on Ubuntu.