From 8a7ba4a1327ee8c3084b4099102e5372e8d95738 Mon Sep 17 00:00:00 2001 From: Josh Kelley Date: Tue, 19 Nov 2024 10:59:51 -0500 Subject: [PATCH] docs: Add docs for 1.49.0's new "chromium" option Reword channel documentation - as someone unfamiliar with the differences in Playwright's use of Chromium versus Google Chrome, I found the 1.49.0 release notes confusing. This may help. Update browsers.md list of channels to match params.md. --- docs/src/api/params.md | 6 ++++- docs/src/browsers.md | 2 +- packages/playwright-core/types/types.d.ts | 27 +++++++++++++++-------- packages/playwright/types/test.d.ts | 9 +++++--- 4 files changed, 30 insertions(+), 14 deletions(-) diff --git a/docs/src/api/params.md b/docs/src/api/params.md index 9b8d3de31b..e059fffe46 100644 --- a/docs/src/api/params.md +++ b/docs/src/api/params.md @@ -1001,7 +1001,11 @@ Additional arguments to pass to the browser instance. The list of Chromium flags ## browser-option-channel - `channel` <[string]> -Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using [Google Chrome and Microsoft Edge](../browsers.md#google-chrome--microsoft-edge). +Browser distribution channel. + +Use "chromium" to [opt in to new headless mode](../browsers.md#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](../browsers.md#google-chrome--microsoft-edge). ## browser-option-chromiumsandbox - `chromiumSandbox` <[boolean]> diff --git a/docs/src/browsers.md b/docs/src/browsers.md index 1321ed8549..83ea0f60c3 100644 --- a/docs/src/browsers.md +++ b/docs/src/browsers.md @@ -423,7 +423,7 @@ dotnet test -- Playwright.BrowserName=chromium Playwright.LaunchOptions.Channel= While Playwright can download and use the recent Chromium build, it can operate against the branded Google Chrome and Microsoft Edge browsers available on the machine (note that Playwright doesn't install them by default). In particular, the current Playwright version will support Stable and Beta channels of these browsers. -Available channels are `chrome`, `msedge`, `chrome-beta`, `msedge-beta` or `msedge-dev`. +Available channels are `chrome`, `msedge`, `chrome-beta`, `msedge-beta`, `chrome-dev`, `msedge-dev`, `chrome-canary`, `msedge-canary`. :::warning Certain Enterprise Browser Policies may impact Playwright's ability to launch and control Google Chrome and Microsoft Edge. Running in an environment with browser policies is outside of the Playwright project's scope. diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts index 85dd2d50a6..865fd0cb7c 100644 --- a/packages/playwright-core/types/types.d.ts +++ b/packages/playwright-core/types/types.d.ts @@ -14709,9 +14709,12 @@ export interface BrowserType { bypassCSP?: boolean; /** - * Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", - * "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using - * [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). + * Browser distribution channel. + * + * Use "chromium" to [opt in to new headless mode](https://playwright.dev/docs/browsers#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](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). */ channel?: string; @@ -15205,9 +15208,12 @@ export interface BrowserType { args?: Array; /** - * Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", - * "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using - * [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). + * Browser distribution channel. + * + * Use "chromium" to [opt in to new headless mode](https://playwright.dev/docs/browsers#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](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). */ channel?: string; @@ -21540,9 +21546,12 @@ export interface LaunchOptions { args?: Array; /** - * Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", - * "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using - * [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). + * Browser distribution channel. + * + * Use "chromium" to [opt in to new headless mode](https://playwright.dev/docs/browsers#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](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). */ channel?: string; diff --git a/packages/playwright/types/test.d.ts b/packages/playwright/types/test.d.ts index 715762cffe..3111aa8764 100644 --- a/packages/playwright/types/test.d.ts +++ b/packages/playwright/types/test.d.ts @@ -5776,9 +5776,12 @@ export interface PlaywrightWorkerOptions { */ headless: boolean; /** - * Browser distribution channel. Supported values are "chrome", "chrome-beta", "chrome-dev", "chrome-canary", - * "msedge", "msedge-beta", "msedge-dev", "msedge-canary". Read more about using - * [Google Chrome and Microsoft Edge](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). + * Browser distribution channel. + * + * Use "chromium" to [opt in to new headless mode](https://playwright.dev/docs/browsers#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](https://playwright.dev/docs/browsers#google-chrome--microsoft-edge). * * **Usage** *