Interface 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:

Hierarchy

  • Electron

Methods

launch

Methods

launch

  • Launches electron application specified with the executablePath.

    Parameters

    • Optional options: {
          acceptDownloads?: boolean;
          args?: string[];
          bypassCSP?: boolean;
          colorScheme?: "light" | "dark" | "no-preference";
          cwd?: string;
          env?: {
              [key: string]: string;
          };
          executablePath?: string;
          extraHTTPHeaders?: {
              [key: string]: string;
          };
          geolocation?: {
              accuracy?: number;
              latitude: number;
              longitude: number;
          };
          httpCredentials?: {
              origin?: string;
              password: string;
              send?: "unauthorized" | "always";
              username: string;
          };
          ignoreHTTPSErrors?: boolean;
          locale?: string;
          offline?: boolean;
          recordHar?: {
              content?: "omit" | "embed" | "attach";
              mode?: "full" | "minimal";
              omitContent?: boolean;
              path: string;
              urlFilter?: string | RegExp;
          };
          recordVideo?: {
              dir: string;
              size?: {
                  height: number;
                  width: number;
              };
          };
          timeout?: number;
          timezoneId?: string;
          tracesDir?: string;
      }
      Optional
      • Optional acceptDownloads?: boolean

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

      • Optional args?: string[]

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

      • Optional bypassCSP?: boolean

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

      • Optional colorScheme?: "light" | "dark" | "no-preference"

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

      • Optional cwd?: string

        Current working directory to launch application from.

      • Optional env?: {
            [key: string]: string;
        }

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

        • [key: string]: string
      • Optional executablePath?: string

        Launches given Electron application. If not specified, launches the default Electron executable installed in this package, located at node_modules/.bin/electron.

      • Optional extraHTTPHeaders?: {
            [key: string]: string;
        }

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

        • [key: string]: string
      • Optional geolocation?: {
            accuracy?: number;
            latitude: number;
            longitude: number;
        }
        • Optional accuracy?: number

          Non-negative accuracy value. Defaults to 0.

        • latitude: number

          Latitude between -90 and 90.

        • longitude: number

          Longitude between -180 and 180.

      • Optional httpCredentials?: {
            origin?: string;
            password: string;
            send?: "unauthorized" | "always";
            username: string;
        }

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

        • Optional origin?: string

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

        • password: string
        • Optional send?: "unauthorized" | "always"

          This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.

        • username: string
      • Optional ignoreHTTPSErrors?: boolean

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

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

      • Optional offline?: boolean

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

      • Optional recordHar?: {
            content?: "omit" | "embed" | "attach";
            mode?: "full" | "minimal";
            omitContent?: boolean;
            path: string;
            urlFilter?: string | RegExp;
        }

        Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close([options]) for the HAR to be saved.

        • Optional content?: "omit" | "embed" | "attach"

          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.

        • Optional mode?: "full" | "minimal"

          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.

        • Optional omitContent?: boolean

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

        • 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.

        • Optional urlFilter?: string | RegExp

          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.

      • Optional recordVideo?: {
            dir: string;
            size?: {
                height: number;
                width: number;
            };
        }

        Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close([options]) for videos to be saved.

        • dir: string

          Path to the directory to put videos into.

        • Optional size?: {
              height: number;
              width: number;
          }

          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.

          • height: number

            Video frame height.

          • width: number

            Video frame width.

      • Optional timeout?: number

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

      • Optional timezoneId?: string

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

      • Optional tracesDir?: string

        If specified, traces are saved into this directory.

    Returns Promise<ElectronApplication>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc