Skip to main content
Version: 1.22

Electron

Playwright has experimental support for Electron automation. You can access electron namespace via:

const { _electron } = require('playwright');

An example of the Electron automation script would be:

const { _electron: electron } = require('playwright');

(async () => {
// Launch Electron app.
const electronApp = await electron.launch({ args: ['main.js'] });

// Evaluation expression in the Electron context.
const appPath = await electronApp.evaluate(async ({ app }) => {
// This runs in the main Electron process, parameter here is always
// the result of the require('electron') in the main app script.
return app.getAppPath();
});
console.log(appPath);

// Get the first window that the app opens, wait if necessary.
const window = await electronApp.firstWindow();
// Print the title.
console.log(await window.title());
// Capture a screenshot.
await window.screenshot({ path: 'intro.png' });
// Direct Electron console to Node terminal.
window.on('console', console.log);
// Click button.
await window.click('text=Click me');
// Exit app.
await electronApp.close();
})();

Note that since you don't need Playwright to install web browsers when testing Electron, you can omit browser download via setting the following environment variable when installing Playwright:

PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright

Supported Electron versions are:

  • v12.2.0+
  • v13.4.0+
  • v14+

electron.launch([options])

  • options? <Object>
    • acceptDownloads? <boolean> Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.#
    • args? <Array<string>> Additional arguments to pass to the application when launching. You typically pass the main script name here.#
    • bypassCSP? <boolean> Toggles bypassing page's Content-Security-Policy.#
    • colorScheme? <"light"|"dark"|"no-preference"> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulateMedia([options]) for more details. Defaults to 'light'.#
    • cwd? <string> Current working directory to launch application from.#
    • env? <Object<string, string>> Specifies environment variables that will be visible to Electron. Defaults to process.env.#
    • executablePath? <string> Launches given Electron application. If not specified, launches the default Electron executable installed in this package, located at node_modules/.bin/electron.#
    • extraHTTPHeaders? <Object<string, string>> An object containing additional HTTP headers to be sent with every request.#
    • geolocation? <Object>#
      • latitude <number> Latitude between -90 and 90.
      • longitude <number> Longitude between -180 and 180.
      • accuracy? <number> Non-negative accuracy value. Defaults to 0.
    • httpCredentials? <Object> Credentials for HTTP authentication.#
    • ignoreHTTPSErrors? <boolean> Whether to ignore HTTPS errors when sending network requests. Defaults to false.#
    • locale? <string> Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules.#
    • offline? <boolean> Whether to emulate network being offline. Defaults to false.#
    • recordHar? <Object> Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close() for the HAR to be saved.#
      • omitContent? <boolean> Optional setting to control whether to omit request content from the HAR. Defaults to false.
      • path <string> Path on the filesystem to write the HAR file to.
    • recordVideo? <Object> Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close() for videos to be saved.#
      • dir <string> Path to the directory to put videos into.
      • size? <Object> Optional dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.
        • width <number> Video frame width.
        • height <number> Video frame height.
    • timeout? <number> Maximum time in milliseconds to wait for the application to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.#
    • timezoneId? <string> Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs.#
  • returns: <Promise<ElectronApplication>>#

Launches electron application specified with the executablePath.