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();
})();

Supported Electron versions are:

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

Known issues:

If you are not able to launch Electron and it will end up in timeouts during launch, try the following:

• Ensure that nodeCliInspect (FuseV1Options.EnableNodeCliInspectArguments) fuse is not set to false.

Methods​

launch​

Launches electron application specified with the executablePath.

Usage

await electron.launch();
await electron.launch(options);

Arguments

• options Object (optional)

  • acceptDownloads boolean (optional)

    Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.

  • args Array<string> (optional)

    Additional arguments to pass to the application when launching. You typically pass the main script name here.

  • bypassCSP boolean (optional)

    Toggles bypassing page's Content-Security-Policy. Defaults to false.

  • colorScheme null | "light" | "dark" | "no-preference" (optional)

    Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'light'.

  • cwd string (optional)

    Current working directory to launch application from.

  • env Object<string, string> (optional)

    Specifies environment variables that will be visible to Electron. Defaults to process.env.

  • executablePath string (optional)

    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> (optional)

    An object containing additional HTTP headers to be sent with every request. Defaults to none.

  • geolocation Object (optional)

    • latitude number

      Latitude between -90 and 90.

    • longitude number

      Longitude between -180 and 180.

    • accuracy number (optional)

      Non-negative accuracy value. Defaults to 0.

  • httpCredentials Object (optional)

    • username string

    • password string

    • origin string (optional)

      Restrain sending http credentials on specific origin (scheme://host:port).

    Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

  • ignoreHTTPSErrors boolean (optional)

    Whether to ignore HTTPS errors when sending network requests. Defaults to false.

  • locale string (optional)

    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. Defaults to the system default locale. Learn more about emulation in our emulation guide.

  • offline boolean (optional)

    Whether to emulate network being offline. Defaults to false. Learn more about network emulation.

  • recordHar Object (optional)

    • omitContent boolean (optional)

      Optional setting to control whether to omit request content from the HAR. Defaults to false. Deprecated, use content policy instead.

    • content "omit" | "embed" | "attach" (optional)

      Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file as per HAR specification. Defaults to attach for .zip output files and to embed for all other file extensions.

    • path string

      Path on the filesystem to write the HAR file to. If the file name ends with .zip, content: 'attach' is used by default.

    • mode "full" | "minimal" (optional)

      When set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.

    • urlFilter string | RegExp (optional)

      A glob or regex pattern to filter requests that are stored in the HAR. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor. Defaults to none.

    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.

  • recordVideo Object (optional)

    • dir string

      Path to the directory to put videos into.

    • size Object (optional)

      • width number

        Video frame width.

      • height number

        Video frame height.

      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.

    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.

  • timeout number (optional)

    Maximum time in milliseconds to wait for the application to start. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

  • timezoneId string (optional)

    Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.

  • tracesDir string (optional)

    If specified, traces are saved into this directory.

Returns

• Promise<ElectronApplication>