Skip to content

Commit 40670e6

Browse files
Skn0ttdgozman
andauthored
fix(emulate media): document "no-preference" as deprecated (#32881)
Closes #32862. `prefers-color-scheme: no-preference` was removed from browsers. This PR marks it as deprecated in our docs and removes all mentions. --------- Signed-off-by: Simon Knott <[email protected]> Co-authored-by: Dmitry Gozman <[email protected]>
1 parent 80ff7c3 commit 40670e6

File tree

6 files changed

+23
-27
lines changed

6 files changed

+23
-27
lines changed

docs/src/api/class-page.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,8 +1217,6 @@ await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
12171217
// → true
12181218
await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
12191219
// → false
1220-
await page.evaluate(() => matchMedia('(prefers-color-scheme: no-preference)').matches);
1221-
// → false
12221220
```
12231221

12241222
```java
@@ -1227,8 +1225,6 @@ page.evaluate("() => matchMedia('(prefers-color-scheme: dark)').matches");
12271225
// → true
12281226
page.evaluate("() => matchMedia('(prefers-color-scheme: light)').matches");
12291227
// → false
1230-
page.evaluate("() => matchMedia('(prefers-color-scheme: no-preference)').matches");
1231-
// → false
12321228
```
12331229

12341230
```python async
@@ -1237,8 +1233,6 @@ await page.evaluate("matchMedia('(prefers-color-scheme: dark)').matches")
12371233
# → True
12381234
await page.evaluate("matchMedia('(prefers-color-scheme: light)').matches")
12391235
# → False
1240-
await page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")
1241-
# → False
12421236
```
12431237

12441238
```python sync
@@ -1247,7 +1241,6 @@ page.evaluate("matchMedia('(prefers-color-scheme: dark)').matches")
12471241
# → True
12481242
page.evaluate("matchMedia('(prefers-color-scheme: light)').matches")
12491243
# → False
1250-
page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")
12511244
```
12521245

12531246
```csharp
@@ -1256,8 +1249,6 @@ await page.EvaluateAsync("matchMedia('(prefers-color-scheme: dark)').matches");
12561249
// → true
12571250
await page.EvaluateAsync("matchMedia('(prefers-color-scheme: light)').matches");
12581251
// → false
1259-
await page.EvaluateAsync("matchMedia('(prefers-color-scheme: no-preference)').matches");
1260-
// → false
12611252
```
12621253

12631254
### option: Page.emulateMedia.media
@@ -1281,16 +1272,16 @@ Passing `'Null'` disables CSS media emulation.
12811272
* langs: js, java
12821273
- `colorScheme` <null|[ColorScheme]<"light"|"dark"|"no-preference">>
12831274

1284-
Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. Passing
1285-
`null` disables color scheme emulation.
1275+
Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media feature, supported values are `'light'` and `'dark'`. Passing
1276+
`null` disables color scheme emulation. `'no-preference'` is deprecated.
12861277

12871278
### option: Page.emulateMedia.colorScheme
12881279
* since: v1.9
12891280
* langs: csharp, python
12901281
- `colorScheme` <[ColorScheme]<"light"|"dark"|"no-preference"|"null">>
12911282

1292-
Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. Passing
1293-
`'Null'` disables color scheme emulation.
1283+
Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media feature, supported values are `'light'` and `'dark'`. Passing
1284+
`'Null'` disables color scheme emulation. `'no-preference'` is deprecated.
12941285

12951286
### option: Page.emulateMedia.reducedMotion
12961287
* since: v1.12

docs/src/api/params.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -639,14 +639,14 @@ If no origin is specified, the username and password are sent to any servers upo
639639
* langs: js, java
640640
- `colorScheme` <null|[ColorScheme]<"light"|"dark"|"no-preference">>
641641

642-
Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
642+
Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media feature, supported values are `'light'` and `'dark'`. See
643643
[`method: Page.emulateMedia`] for more details. Passing `null` resets emulation to system defaults. Defaults to `'light'`.
644644

645645
## context-option-colorscheme-csharp-python
646646
* langs: csharp, python
647647
- `colorScheme` <[ColorScheme]<"light"|"dark"|"no-preference"|"null">>
648648

649-
Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
649+
Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media feature, supported values are `'light'` and `'dark'`. See
650650
[`method: Page.emulateMedia`] for more details. Passing `'null'` resets emulation to system defaults. Defaults to `'light'`.
651651

652652
## context-option-reducedMotion

docs/src/emulation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ await context.SetGeolocationAsync(new Geolocation() { Longitude = 48.858455, Lat
558558
**Note** you can only change geolocation for all pages in the context.
559559
## Color Scheme and Media
560560

561-
Emulate the users `"colorScheme"`. Supported values are 'light', 'dark', 'no-preference'. You can also emulate the media type with [`method: Page.emulateMedia`].
561+
Emulate the users `"colorScheme"`. Supported values are 'light' and 'dark'. You can also emulate the media type with [`method: Page.emulateMedia`].
562562

563563
```js title="playwright.config.ts"
564564
import { defineConfig } from '@playwright/test';

docs/src/test-use-options-js.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export default defineConfig({
6464

6565
| Option | Description |
6666
| :- | :- |
67-
| [`property: TestOptions.colorScheme`] | [Emulates](./emulation.md#color-scheme-and-media) `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'` |
67+
| [`property: TestOptions.colorScheme`] | [Emulates](./emulation.md#color-scheme-and-media) `'prefers-colors-scheme'` media feature, supported values are `'light'` and `'dark'` |
6868
| [`property: TestOptions.geolocation`] | Context [geolocation](./emulation.md#geolocation). |
6969
| [`property: TestOptions.locale`] | [Emulates](./emulation.md#locale--timezone) the user locale, for example `en-GB`, `de-DE`, etc. |
7070
| [`property: TestOptions.permissions`] | A list of [permissions](./emulation.md#permissions) to grant to all pages in the context. |

packages/playwright-core/types/types.d.ts

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2553,16 +2553,15 @@ export interface Page {
25532553
* // → true
25542554
* await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
25552555
* // → false
2556-
* await page.evaluate(() => matchMedia('(prefers-color-scheme: no-preference)').matches);
2557-
* // → false
25582556
* ```
25592557
*
25602558
* @param options
25612559
*/
25622560
emulateMedia(options?: {
25632561
/**
2564-
* Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`.
2565-
* Passing `null` disables color scheme emulation.
2562+
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
2563+
* media feature, supported values are `'light'` and `'dark'`. Passing `null` disables color scheme emulation.
2564+
* `'no-preference'` is deprecated.
25662565
*/
25672566
colorScheme?: null|"light"|"dark"|"no-preference";
25682567

@@ -9761,7 +9760,8 @@ export interface Browser {
97619760
}>;
97629761

97639762
/**
9764-
* Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
9763+
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
9764+
* media feature, supported values are `'light'` and `'dark'`. See
97659765
* [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
97669766
* Passing `null` resets emulation to system defaults. Defaults to `'light'`.
97679767
*/
@@ -14726,7 +14726,8 @@ export interface BrowserType<Unused = {}> {
1472614726
}>;
1472714727

1472814728
/**
14729-
* Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
14729+
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
14730+
* media feature, supported values are `'light'` and `'dark'`. See
1473014731
* [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
1473114732
* Passing `null` resets emulation to system defaults. Defaults to `'light'`.
1473214733
*/
@@ -16522,7 +16523,8 @@ export interface AndroidDevice {
1652216523
bypassCSP?: boolean;
1652316524

1652416525
/**
16525-
* Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
16526+
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
16527+
* media feature, supported values are `'light'` and `'dark'`. See
1652616528
* [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
1652716529
* Passing `null` resets emulation to system defaults. Defaults to `'light'`.
1652816530
*/
@@ -18998,7 +19000,8 @@ export interface Electron {
1899819000
bypassCSP?: boolean;
1899919001

1900019002
/**
19001-
* Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
19003+
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
19004+
* media feature, supported values are `'light'` and `'dark'`. See
1900219005
* [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
1900319006
* Passing `null` resets emulation to system defaults. Defaults to `'light'`.
1900419007
*/
@@ -21820,7 +21823,8 @@ export interface BrowserContextOptions {
2182021823
}>;
2182121824

2182221825
/**
21823-
* Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
21826+
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
21827+
* media feature, supported values are `'light'` and `'dark'`. See
2182421828
* [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
2182521829
* Passing `null` resets emulation to system defaults. Defaults to `'light'`.
2182621830
*/

packages/playwright/types/test.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5225,7 +5225,8 @@ export interface PlaywrightTestOptions {
52255225
*/
52265226
bypassCSP: boolean;
52275227
/**
5228-
* Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See
5228+
* Emulates [prefers-colors-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
5229+
* media feature, supported values are `'light'` and `'dark'`. See
52295230
* [page.emulateMedia([options])](https://playwright.dev/docs/api/class-page#page-emulate-media) for more details.
52305231
* Passing `null` resets emulation to system defaults. Defaults to `'light'`.
52315232
*

0 commit comments

Comments
 (0)