Interface PlaywrightWorkerOptions

Name of the browser that runs tests. Defaults to 'chromium'. Most of the time you should set browserName in your TestConfig:

Usage

// playwright.config.ts
import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
  use: {
    browserName: 'firefox',
  },
});
Copy

Browser distribution channel.

Use "chromium" to opt in to new headless mode.

Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.

Usage

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  projects: [
    {
      name: 'Microsoft Edge',
      use: {
        ...devices['Desktop Edge'],
        channel: 'msedge'
      },
    },
  ]
});
Copy

Usage

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    connectOptions: {
      wsEndpoint: 'ws://localhost:5678',
    },
  },
});
Copy

When connect options are specified, default fixtures.browser, fixtures.context and fixtures.page use the remote browser instead of launching a browser locally, and any launch options like testOptions.headless or testOptions.channel are ignored.

Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true.

Usage

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    headless: false
  },
});
Copy

Options used to launch the browser, as passed to browserType.launch([options]). Specific options testOptions.headless and testOptions.channel take priority over this.

NOTE Use custom browser args at your own risk, as some of them may break Playwright functionality.

Usage

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  projects: [
    {
      name: 'chromium',
      use: {
        ...devices['Desktop Chrome'],
        launchOptions: {
          args: ['--start-maximized']
        }
      }
    }
  ]
});
Copy

Whether to automatically capture a screenshot after each test. Defaults to 'off'.

• 'off': Do not capture screenshots.
• 'on': Capture screenshot after each test.
• 'only-on-failure': Capture screenshot after each test failure.
• 'on-first-failure': Capture screenshot after each test's first failure.

Usage

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    screenshot: 'only-on-failure',
  },
});
Copy

Learn more about automatic screenshots.

Whether to record trace for each test. Defaults to 'off'.

• 'off': Do not record trace.
• 'on': Record trace for each test.
• 'on-first-retry': Record trace only when retrying a test for the first time.
• 'on-all-retries': Record trace only when retrying a test.
• 'retain-on-failure': Record trace for each test. When test run passes, remove the recorded trace.
• 'retain-on-first-failure': Record trace for the first run of each test, but not for retries. When test run passes, remove the recorded trace.
• 'retain-on-failure-and-retries': Record trace for each test run. Retains all traces when an attempt fails.

For more control, pass an object that specifies mode and trace features to enable.

Usage

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    trace: 'on-first-retry'
  },
});
Copy

Learn more about recording trace.

Whether to record video for each test. Defaults to 'off'.

• 'off': Do not record video.
• 'on': Record video for each test.
• 'retain-on-failure': Record video for each test, but remove all videos from successful test runs.
• 'on-first-retry': Record video only when retrying a test for the first time.

To control video size, pass an object with mode and size properties. If video size is not specified, it will be equal to testOptions.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.

To annotate actions in the video, pass show with action and/or test sub-options. The action option controls visual highlights on interacted elements with an optional delay in milliseconds (defaults to 500). The test option controls which test information is displayed as a status overlay.

Usage

// playwright.config.ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    video: 'on-first-retry',
  },
});
Copy

Learn more about recording video.