Skip to content

docs(connectOverCDP): describe noDefaults via Playwright options #40607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yury-s merged 1 commit into from
May 4, 2026
+26 −15
Merged

docs(connectOverCDP): describe noDefaults via Playwright options #40607

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/src/api/class-browsertype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,15 +225,16 @@ Maximum time in milliseconds to wait for the connection to be established. Defau
`30000` (30 seconds). Pass `0` to disable timeout.

### option: BrowserType.connectOverCDP.noDefaults
* since: v1.53
* since: v1.60
- `noDefaults` <[boolean]>

When true, Playwright will not send default overrides to the browser on the default context. This includes
`Browser.setDownloadBehavior`, `Emulation.setFocusEmulationEnabled`, and `Emulation.setEmulatedMedia`.
Useful when attaching to a user's daily-driver browser where these overrides would interfere with
existing browser state. New contexts created via
[browser.newContext([options])](https://playwright.dev/docs/api/class-browser#browser-new-context)
are not affected. Defaults to `false`.
When true, Playwright will not apply its default overrides to the existing default browser context.
Specifically, [`option: Browser.newContext.acceptDownloads`] is left at the browser's setting, focus
emulation is not enabled, and media emulation options (such as [`option: Browser.newContext.colorScheme`],
[`option: Browser.newContext.reducedMotion`], [`option: Browser.newContext.forcedColors`], and
[`option: Browser.newContext.contrast`]) are not applied. Useful when attaching to a user's daily-driver
browser where these overrides would interfere with existing browser state. New contexts created via
[`method: Browser.newContext`] are not affected. Defaults to `false`.


## method: BrowserType.executablePath
Expand Down
13 changes: 9 additions & 4 deletions packages/playwright-client/types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22899,10 +22899,15 @@ export interface ConnectOverCDPOptions {
isLocal?: boolean;

/**
* When true, Playwright will not send default overrides to the browser on the default context. This includes
* `Browser.setDownloadBehavior`, `Emulation.setFocusEmulationEnabled`, and `Emulation.setEmulatedMedia`. Useful when
* attaching to a user's daily-driver browser where these overrides would interfere with existing browser state. New
* contexts created via
* When true, Playwright will not apply its default overrides to the existing default browser context. Specifically,
* [`acceptDownloads`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-accept-downloads) is
* left at the browser's setting, focus emulation is not enabled, and media emulation options (such as
* [`colorScheme`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme),
* [`reducedMotion`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-reduced-motion),
* [`forcedColors`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-forced-colors), and
* [`contrast`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-contrast)) are not applied.
* Useful when attaching to a user's daily-driver browser where these overrides would interfere with existing browser
* state. New contexts created via
* [browser.newContext([options])](https://playwright.dev/docs/api/class-browser#browser-new-context) are not
* affected. Defaults to `false`.
*/
Expand Down
13 changes: 9 additions & 4 deletions packages/playwright-core/types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22899,10 +22899,15 @@ export interface ConnectOverCDPOptions {
isLocal?: boolean;

/**
* When true, Playwright will not send default overrides to the browser on the default context. This includes
* `Browser.setDownloadBehavior`, `Emulation.setFocusEmulationEnabled`, and `Emulation.setEmulatedMedia`. Useful when
* attaching to a user's daily-driver browser where these overrides would interfere with existing browser state. New
* contexts created via
* When true, Playwright will not apply its default overrides to the existing default browser context. Specifically,
* [`acceptDownloads`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-accept-downloads) is
* left at the browser's setting, focus emulation is not enabled, and media emulation options (such as
* [`colorScheme`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme),
* [`reducedMotion`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-reduced-motion),
* [`forcedColors`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-forced-colors), and
* [`contrast`](https://playwright.dev/docs/api/class-browser#browser-new-context-option-contrast)) are not applied.
* Useful when attaching to a user's daily-driver browser where these overrides would interfere with existing browser
* state. New contexts created via
* [browser.newContext([options])](https://playwright.dev/docs/api/class-browser#browser-new-context) are not
* affected. Defaults to `false`.
*/
Expand Down
Loading