Skip to content
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

Jump to bottom

DO NOT MERGE: Technical review for Window Management API docs #28851

Closed
wants to merge 12 commits into from
Closed

DO NOT MERGE: Technical review for Window Management API docs #28851

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
198e6fd
Add docs for the Window Management API
chrisdavidmills Aug 30, 2023
f702ac1
Adding rest of pages for the API
chrisdavidmills Sep 4, 2023
6321a5e
Adding information about the multi-screen origin
chrisdavidmills Sep 5, 2023
cdaefab
Merge branch 'main' into window-management-api
chrisdavidmills Sep 5, 2023
aef485e
Merge branch 'main' into window-management-api
chrisdavidmills Sep 26, 2023
1a84d53
Merge branch 'main' into window-management-api
chrisdavidmills Sep 29, 2023
abc63d6
Merge branch 'main' into window-management-api
chrisdavidmills Oct 16, 2023
9193823
Making fixes for michaelwasserman comments
chrisdavidmills Oct 17, 2023
986f5c3
Merge branch 'main' into window-management-api
chrisdavidmills Oct 17, 2023
f58e40d
Fixes for 2nd round of michaelwasserman comments
chrisdavidmills Oct 18, 2023
aaa6742
Merge branch 'main' into window-management-api
chrisdavidmills Oct 18, 2023
d7b8d00
Merge branch 'main' into window-management-api
chrisdavidmills Oct 19, 2023
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
44 changes: 24 additions & 20 deletions files/en-us/_redirects.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2214,17 +2214,17 @@
/en-US/docs/DOM/window.restore /en-US/docs/Web/API/Window/moveTo
/en-US/docs/DOM/window.screen /en-US/docs/Web/API/Window/screen
/en-US/docs/DOM/window.screen.availHeight /en-US/docs/Web/API/Screen/availHeight
/en-US/docs/DOM/window.screen.availLeft /en-US/docs/Web/API/Screen/availLeft
/en-US/docs/DOM/window.screen.availTop /en-US/docs/Web/API/Screen/availTop
/en-US/docs/DOM/window.screen.availLeft /en-US/docs/Web/API/ScreenDetailed/availLeft
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't redirect folks looking for window.screen.availLeft (etc.) to the ScreenDetailed definition; they should continue to see existing https://developer.mozilla.org/en-US/docs/Web/API/Screen/availLeft (etc.) docs about the pre-existing non-standard properties defined on the Screen interface object window.screen. Right?

Copy link
Contributor Author

@chrisdavidmills chrisdavidmills Oct 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hrm, this is a difficult situation to decide what is best. I do see your point, but at the same time, I feel that it is good to document the standardized version over the non-standard version in such cases. Plus, it is good to document features in one place rather than two otherwise you run the risk of reader confusion and maintenance difficulties.

I have thought about this a bit, and come to the following executive decision:

  • I am going to keep both sets of compat data for the affected properties. To represent both stories in the compat data in one place is too confusing and tricky, and will confuse more than it helps. (I tried to do so yesterday for quite a while, and just gave up in the end!)
  • I am keep the documentation for the affected properties in one place — hanging off ScreenDetailed.
  • I will add a note and a section to each of these pages to make the non-standard version support situation clear.
  • I will add a section to the main Screen page listing the non-standard versions and pointing to where they are documented.

Let me know what you think of these changes (in the next commit).

/en-US/docs/DOM/window.screen.availTop /en-US/docs/Web/API/ScreenDetailed/availTop
/en-US/docs/DOM/window.screen.availWidth /en-US/docs/Web/API/Screen/availWidth
/en-US/docs/DOM/window.screen.colorDepth /en-US/docs/Web/API/Screen/colorDepth
/en-US/docs/DOM/window.screen.height /en-US/docs/Web/API/Screen/height
/en-US/docs/DOM/window.screen.left /en-US/docs/Web/API/Screen/left
/en-US/docs/DOM/window.screen.left /en-US/docs/Web/API/ScreenDetailed/left
/en-US/docs/DOM/window.screen.lockOrientation /en-US/docs/Web/API/Screen/lockOrientation
/en-US/docs/DOM/window.screen.mozBrightness /en-US/docs/Web/API/Screen/mozBrightness
/en-US/docs/DOM/window.screen.mozEnabled /en-US/docs/Web/API/Screen/mozEnabled
/en-US/docs/DOM/window.screen.pixelDepth /en-US/docs/Web/API/Screen/pixelDepth
/en-US/docs/DOM/window.screen.top /en-US/docs/Web/API/Screen/top
/en-US/docs/DOM/window.screen.top /en-US/docs/Web/API/ScreenDetailed/top
/en-US/docs/DOM/window.screen.width /en-US/docs/Web/API/Screen/width
/en-US/docs/DOM/window.screenX /en-US/docs/Web/API/Window/screenX
/en-US/docs/DOM/window.screenY /en-US/docs/Web/API/Window/screenY
Expand Down Expand Up @@ -2642,14 +2642,14 @@
/en-US/docs/DOM:window.resizeTo /en-US/docs/Web/API/Window/resizeTo
/en-US/docs/DOM:window.screen /en-US/docs/Web/API/Window/screen
/en-US/docs/DOM:window.screen.availHeight /en-US/docs/Web/API/Screen/availHeight
/en-US/docs/DOM:window.screen.availLeft /en-US/docs/Web/API/Screen/availLeft
/en-US/docs/DOM:window.screen.availTop /en-US/docs/Web/API/Screen/availTop
/en-US/docs/DOM:window.screen.availLeft /en-US/docs/Web/API/ScreenDetailed/availLeft
/en-US/docs/DOM:window.screen.availTop /en-US/docs/Web/API/ScreenDetailed/availTop
/en-US/docs/DOM:window.screen.availWidth /en-US/docs/Web/API/Screen/availWidth
/en-US/docs/DOM:window.screen.colorDepth /en-US/docs/Web/API/Screen/colorDepth
/en-US/docs/DOM:window.screen.height /en-US/docs/Web/API/Screen/height
/en-US/docs/DOM:window.screen.left /en-US/docs/Web/API/Screen/left
/en-US/docs/DOM:window.screen.left /en-US/docs/Web/API/ScreenDetailed/left
/en-US/docs/DOM:window.screen.pixelDepth /en-US/docs/Web/API/Screen/pixelDepth
/en-US/docs/DOM:window.screen.top /en-US/docs/Web/API/Screen/top
/en-US/docs/DOM:window.screen.top /en-US/docs/Web/API/ScreenDetailed/top
/en-US/docs/DOM:window.screen.width /en-US/docs/Web/API/Screen/width
/en-US/docs/DOM:window.screenX /en-US/docs/Web/API/Window/screenX
/en-US/docs/DOM:window.screenY /en-US/docs/Web/API/Window/screenY
Expand Down Expand Up @@ -3365,14 +3365,14 @@
/en-US/docs/Document_Object_Model_(DOM)/window.restore /en-US/docs/Web/API/Window/moveTo
/en-US/docs/Document_Object_Model_(DOM)/window.screen /en-US/docs/Web/API/Window/screen
/en-US/docs/Document_Object_Model_(DOM)/window.screen.availHeight /en-US/docs/Web/API/Screen/availHeight
/en-US/docs/Document_Object_Model_(DOM)/window.screen.availLeft /en-US/docs/Web/API/Screen/availLeft
/en-US/docs/Document_Object_Model_(DOM)/window.screen.availTop /en-US/docs/Web/API/Screen/availTop
/en-US/docs/Document_Object_Model_(DOM)/window.screen.availLeft /en-US/docs/Web/API/ScreenDetailed/availLeft
/en-US/docs/Document_Object_Model_(DOM)/window.screen.availTop /en-US/docs/Web/API/ScreenDetailed/availTop
/en-US/docs/Document_Object_Model_(DOM)/window.screen.availWidth /en-US/docs/Web/API/Screen/availWidth
/en-US/docs/Document_Object_Model_(DOM)/window.screen.colorDepth /en-US/docs/Web/API/Screen/colorDepth
/en-US/docs/Document_Object_Model_(DOM)/window.screen.height /en-US/docs/Web/API/Screen/height
/en-US/docs/Document_Object_Model_(DOM)/window.screen.left /en-US/docs/Web/API/Screen/left
/en-US/docs/Document_Object_Model_(DOM)/window.screen.left /en-US/docs/Web/API/ScreenDetailed/left
/en-US/docs/Document_Object_Model_(DOM)/window.screen.pixelDepth /en-US/docs/Web/API/Screen/pixelDepth
/en-US/docs/Document_Object_Model_(DOM)/window.screen.top /en-US/docs/Web/API/Screen/top
/en-US/docs/Document_Object_Model_(DOM)/window.screen.top /en-US/docs/Web/API/ScreenDetailed/top
/en-US/docs/Document_Object_Model_(DOM)/window.screen.width /en-US/docs/Web/API/Screen/width
/en-US/docs/Document_Object_Model_(DOM)/window.screenX /en-US/docs/Web/API/Window/screenX
/en-US/docs/Document_Object_Model_(DOM)/window.screenY /en-US/docs/Web/API/Window/screenY
Expand Down Expand Up @@ -9608,22 +9608,26 @@
/en-US/docs/Web/API/SVGStylable /en-US/docs/Web/API/SVGElement
/en-US/docs/Web/API/SVGURIReference /en-US/docs/Web/SVG/Attribute/href
/en-US/docs/Web/API/Screen.availHeight /en-US/docs/Web/API/Screen/availHeight
/en-US/docs/Web/API/Screen.availLeft /en-US/docs/Web/API/Screen/availLeft
/en-US/docs/Web/API/Screen.availTop /en-US/docs/Web/API/Screen/availTop
/en-US/docs/Web/API/Screen.availLeft /en-US/docs/Web/API/ScreenDetailed/availLeft
/en-US/docs/Web/API/Screen.availTop /en-US/docs/Web/API/ScreenDetailed/availTop
/en-US/docs/Web/API/Screen.availWidth /en-US/docs/Web/API/Screen/availWidth
/en-US/docs/Web/API/Screen.colorDepth /en-US/docs/Web/API/Screen/colorDepth
/en-US/docs/Web/API/Screen.height /en-US/docs/Web/API/Screen/height
/en-US/docs/Web/API/Screen.left /en-US/docs/Web/API/Screen/left
/en-US/docs/Web/API/Screen.left /en-US/docs/Web/API/ScreenDetailed/left
/en-US/docs/Web/API/Screen.lockOrientation /en-US/docs/Web/API/Screen/lockOrientation
/en-US/docs/Web/API/Screen.mozBrightness /en-US/docs/Web/API/Screen/mozBrightness
/en-US/docs/Web/API/Screen.mozEnabled /en-US/docs/Web/API/Screen/mozEnabled
/en-US/docs/Web/API/Screen.onorientationchange /en-US/docs/Web/API/Screen/orientationchange_event
/en-US/docs/Web/API/Screen.orientation /en-US/docs/Web/API/Screen/orientation
/en-US/docs/Web/API/Screen.pixelDepth /en-US/docs/Web/API/Screen/pixelDepth
/en-US/docs/Web/API/Screen.top /en-US/docs/Web/API/Screen/top
/en-US/docs/Web/API/Screen.top /en-US/docs/Web/API/ScreenDetailed/top
/en-US/docs/Web/API/Screen.unlockOrientation /en-US/docs/Web/API/Screen/unlockOrientation
/en-US/docs/Web/API/Screen.width /en-US/docs/Web/API/Screen/width
/en-US/docs/Web/API/Screen/availLeft /en-US/docs/Web/API/ScreenDetailed/availLeft
/en-US/docs/Web/API/Screen/availTop /en-US/docs/Web/API/ScreenDetailed/availTop
/en-US/docs/Web/API/Screen/left /en-US/docs/Web/API/ScreenDetailed/left
/en-US/docs/Web/API/Screen/onorientationchange /en-US/docs/Web/API/Screen/orientationchange_event
/en-US/docs/Web/API/Screen/top /en-US/docs/Web/API/ScreenDetailed/top
/en-US/docs/Web/API/ScreenOrientation/onchange /en-US/docs/Web/API/ScreenOrientation/change_event
/en-US/docs/Web/API/ScriptProcessorNode.bufferSize /en-US/docs/Web/API/ScriptProcessorNode/bufferSize
/en-US/docs/Web/API/ScriptProcessorNode.onaudioprocess /en-US/docs/Web/API/ScriptProcessorNode/audioprocess_event
Expand Down Expand Up @@ -10830,19 +10834,19 @@
/en-US/docs/Web/API/window.restore /en-US/docs/Web/API/Window/moveTo
/en-US/docs/Web/API/window.screen /en-US/docs/Web/API/Window/screen
/en-US/docs/Web/API/window.screen.availHeight /en-US/docs/Web/API/Screen/availHeight
/en-US/docs/Web/API/window.screen.availLeft /en-US/docs/Web/API/Screen/availLeft
/en-US/docs/Web/API/window.screen.availTop /en-US/docs/Web/API/Screen/availTop
/en-US/docs/Web/API/window.screen.availLeft /en-US/docs/Web/API/ScreenDetailed/availLeft
/en-US/docs/Web/API/window.screen.availTop /en-US/docs/Web/API/ScreenDetailed/availTop
/en-US/docs/Web/API/window.screen.availWidth /en-US/docs/Web/API/Screen/availWidth
/en-US/docs/Web/API/window.screen.colorDepth /en-US/docs/Web/API/Screen/colorDepth
/en-US/docs/Web/API/window.screen.height /en-US/docs/Web/API/Screen/height
/en-US/docs/Web/API/window.screen.left /en-US/docs/Web/API/Screen/left
/en-US/docs/Web/API/window.screen.left /en-US/docs/Web/API/ScreenDetailed/left
/en-US/docs/Web/API/window.screen.lockOrientation /en-US/docs/Web/API/Screen/lockOrientation
/en-US/docs/Web/API/window.screen.mozBrightness /en-US/docs/Web/API/Screen/mozBrightness
/en-US/docs/Web/API/window.screen.mozEnabled /en-US/docs/Web/API/Screen/mozEnabled
/en-US/docs/Web/API/window.screen.onorientationchange /en-US/docs/Web/API/Screen/orientationchange_event
/en-US/docs/Web/API/window.screen.orientation /en-US/docs/Web/API/Screen/orientation
/en-US/docs/Web/API/window.screen.pixelDepth /en-US/docs/Web/API/Screen/pixelDepth
/en-US/docs/Web/API/window.screen.top /en-US/docs/Web/API/Screen/top
/en-US/docs/Web/API/window.screen.top /en-US/docs/Web/API/ScreenDetailed/top
/en-US/docs/Web/API/window.screen.unlockOrientation /en-US/docs/Web/API/Screen/unlockOrientation
/en-US/docs/Web/API/window.screen.width /en-US/docs/Web/API/Screen/width
/en-US/docs/Web/API/window.screenX /en-US/docs/Web/API/Window/screenX
Expand Down
142 changes: 71 additions & 71 deletions files/en-us/_wikihistory.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57782,41 +57782,6 @@
"Gor1"
]
},
"Web/API/Screen/availLeft": {
chrisdavidmills marked this conversation as resolved.
Show resolved Hide resolved
"modified": "2020-10-15T21:13:04.118Z",
"contributors": [
"mfuji09",
"ExE-Boss",
"fscholz",
"cvrebert",
"Sebastianz",
"teoli",
"MHasan",
"kscarfone",
"Navin_Jadhav",
"Sheppy",
"jzaruba",
"Mgjbot",
"Yaroukh",
"Gor1"
]
},
"Web/API/Screen/availTop": {
"modified": "2020-10-15T21:16:26.852Z",
"contributors": [
"mfuji09",
"ExE-Boss",
"fscholz",
"cvrebert",
"Sebastianz",
"teoli",
"kosvrouvas",
"Navin_Jadhav",
"Sheppy",
"Mgjbot",
"Gor1"
]
},
"Web/API/Screen/availWidth": {
"modified": "2020-10-15T21:16:26.709Z",
"contributors": [
Expand Down Expand Up @@ -57867,23 +57832,6 @@
"Gor1"
]
},
"Web/API/Screen/left": {
"modified": "2020-10-15T21:16:24.841Z",
"contributors": [
"ExE-Boss",
"fscholz",
"cvrebert",
"Sebastianz",
"teoli",
"MHasan",
"namolmes",
"Sheppy",
"Mgjbot",
"Nickolay",
"Jabez",
"Gor1"
]
},
"Web/API/Screen/lockOrientation": {
"modified": "2020-10-15T21:19:41.189Z",
"contributors": [
Expand Down Expand Up @@ -57995,25 +57943,6 @@
"Gor1"
]
},
"Web/API/Screen/top": {
"modified": "2020-10-15T21:16:23.568Z",
"contributors": [
"ExE-Boss",
"fscholz",
"cvrebert",
"teoli",
"jswisher",
"Anonymous",
"MHasan",
"chitra_lakhotia",
"Sheppy",
"ethertank",
"jryans",
"Mgjbot",
"Mw22",
"Gor1"
]
},
"Web/API/Screen/unlockOrientation": {
"modified": "2020-10-15T21:23:44.621Z",
"contributors": [
Expand Down Expand Up @@ -58052,6 +57981,77 @@
"Gor1"
]
},
"Web/API/ScreenDetailed/availLeft": {
"modified": "2020-10-15T21:13:04.118Z",
"contributors": [
"mfuji09",
"ExE-Boss",
"fscholz",
"cvrebert",
"Sebastianz",
"teoli",
"MHasan",
"kscarfone",
"Navin_Jadhav",
"Sheppy",
"jzaruba",
"Mgjbot",
"Yaroukh",
"Gor1"
]
},
"Web/API/ScreenDetailed/availTop": {
"modified": "2020-10-15T21:16:26.852Z",
"contributors": [
"mfuji09",
"ExE-Boss",
"fscholz",
"cvrebert",
"Sebastianz",
"teoli",
"kosvrouvas",
"Navin_Jadhav",
"Sheppy",
"Mgjbot",
"Gor1"
]
},
"Web/API/ScreenDetailed/left": {
"modified": "2020-10-15T21:16:24.841Z",
"contributors": [
"ExE-Boss",
"fscholz",
"cvrebert",
"Sebastianz",
"teoli",
"MHasan",
"namolmes",
"Sheppy",
"Mgjbot",
"Nickolay",
"Jabez",
"Gor1"
]
},
"Web/API/ScreenDetailed/top": {
"modified": "2020-10-15T21:16:23.568Z",
"contributors": [
"ExE-Boss",
"fscholz",
"cvrebert",
"teoli",
"jswisher",
"Anonymous",
"MHasan",
"chitra_lakhotia",
"Sheppy",
"ethertank",
"jryans",
"Mgjbot",
"Mw22",
"Gor1"
]
},
"Web/API/ScreenOrientation": {
"modified": "2020-11-13T05:33:17.108Z",
"contributors": [
Expand Down
19 changes: 19 additions & 0 deletions files/en-us/web/api/element/requestfullscreen/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ requestFullscreen(options)
- `"auto"`
- : The browser will choose which of the above settings to apply.
This is the default value.
- `screen` {{optional_inline}} {{experimental_inline}}
- : Specifies on which screen you want to put the element in fullscreen mode. This takes a {{domxref("ScreenDetailed")}} object as a value, representing the chosen screen.

### Return value

Expand Down Expand Up @@ -157,6 +159,23 @@ elem
The promise's resolve handler does nothing, but if the promise is rejected, an error
message is displayed by calling {{DOMxRef("Window.alert", "alert()")}}.

### Using the screen option

If you wanted to make the element fullscreen on the primary OS screen, you could use code like the following:

```js
try {
const primaryScreen = (await getScreenDetails()).screens.find(
(screen) => screen.isPrimary,
);
await document.body.requestFullscreen({ screen: primaryScreen });
} catch (err) {
console.error(err.name, err.message);
}
```

The {{domxref("Window.getScreenDetails()")}} method is used to retrieve the {{domxref("ScreenDetails")}} object for the current device, which contains {{domxref("ScreenDetailed")}} objects representing the different available screens.

## Specifications

{{Specifications}}
Expand Down
1 change: 1 addition & 0 deletions files/en-us/web/api/permissions_api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ A non-exhaustive list of permission-aware APIs includes:
- [Storage API](/en-US/docs/Web/API/Storage_API): `persistent-storage`
- [Web Audio Output Devices API](/en-US/docs/Web/API/Audio_Output_Devices_API): `speaker-selection`
- [Web MIDI API](/en-US/docs/Web/API/Web_MIDI_API): `midi`
- [Window Management API](/en-US/docs/Web/API/Window_Management_API): `window-management`

## Examples

Expand Down
49 changes: 0 additions & 49 deletions files/en-us/web/api/screen/availleft/index.md
View file
Open in desktop

This file was deleted.

Loading