docs: clarify the null value for the viewport (#20333)

Fixes https://github.com/microsoft/playwright/issues/20284
This commit is contained in:
Pavel Feldman 2023-01-25 17:48:18 -08:00 committed by GitHub
parent f7ff252455
commit 5761a62b1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 41 additions and 7 deletions

View file

@ -276,7 +276,14 @@ When using [`method: Page.goto`], [`method: Page.route`], [`method: Page.waitFor
- `width` <[int]> page width in pixels. - `width` <[int]> page width in pixels.
- `height` <[int]> page height in pixels. - `height` <[int]> page height in pixels.
Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport. Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.
Use `null` to disable the consistent viewport emulation.
:::note
The `null` value opts out from the default presets, makes viewport depend on the
host window size defined by the operating system. It makes the execution of the
tests non-deterministic.
:::
## csharp-context-option-viewport ## csharp-context-option-viewport
* langs: csharp * langs: csharp
@ -285,7 +292,14 @@ Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `n
- `width` <[int]> page width in pixels. - `width` <[int]> page width in pixels.
- `height` <[int]> page height in pixels. - `height` <[int]> page height in pixels.
Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `ViewportSize.NoViewport` to disable the default viewport. Emulates consistent viewport for each page. Defaults to an 1280x720 viewport.
Use `ViewportSize.NoViewport` to disable the consistent viewport emulation.
:::note
The `ViewportSize.NoViewport` value opts out from the default presets,
makes viewport depend on the host window size defined by the operating system.
It makes the execution of the tests non-deterministic.
:::
## context-option-screen ## context-option-screen
* langs: * langs:

View file

@ -12514,7 +12514,11 @@ export interface BrowserType<Unused = {}> {
videosPath?: string; videosPath?: string;
/** /**
* Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport. * Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent
* viewport emulation.
*
* **NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined
* by the operating system. It makes the execution of the tests non-deterministic.
*/ */
viewport?: null|{ viewport?: null|{
/** /**
@ -13877,7 +13881,11 @@ export interface AndroidDevice {
videosPath?: string; videosPath?: string;
/** /**
* Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport. * Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent
* viewport emulation.
*
* **NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined
* by the operating system. It makes the execution of the tests non-deterministic.
*/ */
viewport?: null|{ viewport?: null|{
/** /**
@ -15779,7 +15787,11 @@ export interface Browser extends EventEmitter {
videosPath?: string; videosPath?: string;
/** /**
* Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport. * Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent
* viewport emulation.
*
* **NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined
* by the operating system. It makes the execution of the tests non-deterministic.
*/ */
viewport?: null|{ viewport?: null|{
/** /**
@ -18820,7 +18832,11 @@ export interface BrowserContextOptions {
videosPath?: string; videosPath?: string;
/** /**
* Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport. * Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent
* viewport emulation.
*
* **NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined
* by the operating system. It makes the execution of the tests non-deterministic.
*/ */
viewport?: null|ViewportSize; viewport?: null|ViewportSize;
} }

View file

@ -3523,7 +3523,11 @@ export interface PlaywrightTestOptions {
*/ */
userAgent: string | undefined; userAgent: string | undefined;
/** /**
* Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. `null` disables the default viewport. * Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use `null` to disable the consistent
* viewport emulation.
*
* **NOTE** The `null` value opts out from the default presets, makes viewport depend on the host window size defined
* by the operating system. It makes the execution of the tests non-deterministic.
*/ */
viewport: ViewportSize | null | undefined; viewport: ViewportSize | null | undefined;
/** /**