feat: Add BrowserWindow option to hide window in Mission Control (macOS) #36092

carterbs · 2022-10-20T14:44:10Z

There are many circumstances when app developers may want to hide their windows from mission control. E.g., full screen overlays, small helper windows, dialogs, etc.
This PR adds the functionality, docs, and tests.

Description of Change

Adds hiddenInMissionControl constructor option
Adds isHiddenInMissionControl bw method.
Adds setHiddenInMissionControl bw method.

Checklist

PR description included and stakeholders cc'd
[] npm test passes
tests are added (https://github.com/electron/electron/blob/main/docs/development/testing.md)
relevant documentation is added
PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes:

Adds new setHiddenInMissionControl API to allow developers to opt out of mission control on macOS.

nornagon

I don't love that there are two names for this boolean, "ignoreMissionControl" and "ignoredByMissionControl". Can we settle on one or the other?

docs/api/browser-window.md

carterbs · 2022-10-24T18:35:15Z

I don't love that there are two names for this boolean, "ignoreMissionControl" and "ignoredByMissionControl". Can we settle on one or the other?

The goal was to differentiate the boolean set at construction and the value at runtime.

"Should this window ignore mission control?"
"Is this window ignored by mission control?"

But I hear what you're saying. I'll swap it all for isIgnored as I think it's cleaner, even if it's more verbose.

samuelmaddock

Maybe hiddenInMissionControl would be more easily understood? It also closer aligns with how Apple's docs describe the behavior.

The window floats in Spaces and hides in Mission Control.

https://developer.apple.com/documentation/appkit/nswindowcollectionbehavior/nswindowcollectionbehaviortransient

carterbs · 2022-10-25T12:34:28Z

Works for me. Hoping to get my dev env all set up again to make sure the rename didn't bork something.

…

On Mon, Oct 24, 2022 at 11:06 PM Samuel Maddock ***@***.***> wrote: ***@***.**** commented on this pull request. Maybe hiddenInMissionControl would be more easily understood? It also closer aligns with how Apple's docs describe the behavior. The window floats in Spaces and hides in Mission Control. https://developer.apple.com/documentation/appkit/nswindowcollectionbehavior/nswindowcollectionbehaviortransient — Reply to this email directly, view it on GitHub <#36092 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AD5UD7TOV2NJN2MDD7KCBVDWE5FEHANCNFSM6AAAAAARKHMEEY> . You are receiving this because you authored the thread.Message ID: ***@***.***>

* There are many circumstances when app developers may want to hide their windows from mission control. E.g., full screen overlays, small helper windows, dialogs, etc. * This PR adds the functionality, docs, and tests.

samuelmaddock

API LGTM

shell/browser/native_window_mac.h

nornagon

API LGTM

Co-authored-by: Samuel Maddock <samuel.maddock@gmail.com>

jkleinsc

API LGTM

release-clerk · 2022-11-01T20:43:46Z

Release Notes Persisted

Adds new setHiddenInMissionControl API to allow developers to opt out of mission control on macOS.

VerteDinde · 2022-11-18T02:33:00Z

/trop run backport-to 22-x-y

trop · 2022-11-18T02:33:03Z

The backport process for this PR has been manually initiated - sending your PR to 22-x-y!

trop · 2022-11-18T02:33:29Z

I have automatically backported this PR to "22-x-y", please check out #36390

…OS) (#36092) * feat: Add BrowserWindow option to ignore Mission Control (macOS) * There are many circumstances when app developers may want to hide their windows from mission control. E.g., full screen overlays, small helper windows, dialogs, etc. * This PR adds the functionality, docs, and tests. * chore:Rename variables * Update shell/browser/native_window_mac.h Co-authored-by: Samuel Maddock <samuel.maddock@gmail.com> Co-authored-by: Samuel Maddock <samuel.maddock@gmail.com> Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org> Co-authored-by: Brad Carter <16466430+carterbs@users.noreply.github.com>

miniak · 2023-02-02T00:57:42Z

/trop run backport-to 23-x-y

trop · 2023-02-02T00:57:44Z

The backport process for this PR has been manually initiated - sending your PR to 23-x-y!

trop · 2023-02-02T00:58:04Z

I was unable to backport this PR to "23-x-y" cleanly;
you will need to perform this backport manually.

…OS) (electron#36092) * feat: Add BrowserWindow option to ignore Mission Control (macOS) * There are many circumstances when app developers may want to hide their windows from mission control. E.g., full screen overlays, small helper windows, dialogs, etc. * This PR adds the functionality, docs, and tests. * chore:Rename variables * Update shell/browser/native_window_mac.h Co-authored-by: Samuel Maddock <samuel.maddock@gmail.com> Co-authored-by: Samuel Maddock <samuel.maddock@gmail.com> Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org>

electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Oct 20, 2022

jkleinsc added the semver/minor backwards-compatible functionality label Oct 20, 2022

electron-cation bot added the api-review/requested 🗳 label Oct 20, 2022

nornagon requested changes Oct 24, 2022

View reviewed changes

docs/api/browser-window.md Outdated Show resolved Hide resolved

docs/api/browser-window.md Outdated Show resolved Hide resolved

samuelmaddock reviewed Oct 25, 2022

View reviewed changes

carterbs force-pushed the bradcarter/ignore-mission-control branch from 7cf290f to 05f63c9 Compare October 25, 2022 19:24

carterbs requested a review from nornagon October 25, 2022 19:25

feat: Add BrowserWindow option to ignore Mission Control (macOS)

51641db

* There are many circumstances when app developers may want to hide their windows from mission control. E.g., full screen overlays, small helper windows, dialogs, etc. * This PR adds the functionality, docs, and tests.

carterbs force-pushed the bradcarter/ignore-mission-control branch from 05f63c9 to ebbcc4e Compare October 25, 2022 19:28

chore:Rename variables

3c3fec8

carterbs force-pushed the bradcarter/ignore-mission-control branch from ebbcc4e to 3c3fec8 Compare October 25, 2022 20:32

carterbs changed the title ~~feat: Add BrowserWindow option to ignore Mission Control (macOS)~~ feat: Add BrowserWindow option to hide window in Mission Control (macOS) Oct 25, 2022

samuelmaddock approved these changes Oct 25, 2022

View reviewed changes

shell/browser/native_window_mac.h Outdated Show resolved Hide resolved

samuelmaddock added the no-backport label Oct 25, 2022

nornagon approved these changes Oct 25, 2022

View reviewed changes

carterbs and others added 2 commits October 25, 2022 19:20

Update shell/browser/native_window_mac.h

ef6cd31

Co-authored-by: Samuel Maddock <samuel.maddock@gmail.com>

Merge branch 'main' into bradcarter/ignore-mission-control

81798b4

jkleinsc approved these changes Oct 27, 2022

View reviewed changes

jkleinsc reviewed Oct 27, 2022

View reviewed changes

jkleinsc added the api-review/approved ✅ label Oct 27, 2022

electron-cation bot removed api-review/approved ✅ new-pr 🌱 PR opened in the last 24 hours labels Oct 27, 2022

Merge branch 'main' into bradcarter/ignore-mission-control

66c1f35

jkleinsc merged commit 1554097 into electron:main Nov 1, 2022

VerteDinde added backport/requested 🗳 and removed backport/requested 🗳 labels Nov 18, 2022

trop bot added the needs-manual-bp/21-x-y label Nov 18, 2022

electron deleted a comment from trop bot Nov 18, 2022

trop bot mentioned this pull request Nov 18, 2022

feat: Add BrowserWindow option to hide window in Mission Control (macOS) #36390

Merged

trop bot added the in-flight/22-x-y label Nov 18, 2022

VerteDinde removed the needs-manual-bp/21-x-y label Nov 18, 2022

trop bot added merged/22-x-y PR was merged to the "22-x-y" branch. and removed in-flight/22-x-y labels Jan 26, 2023

trop bot added the needs-manual-bp/23-x-y label Feb 2, 2023

miniak removed the needs-manual-bp/23-x-y label Feb 2, 2023

commit-lint bot mentioned this pull request Feb 20, 2023

[pull] main from electron:main Blaquez-home/electron#3

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add BrowserWindow option to hide window in Mission Control (macOS) #36092

feat: Add BrowserWindow option to hide window in Mission Control (macOS) #36092

carterbs commented Oct 20, 2022 •

edited

nornagon left a comment

carterbs commented Oct 24, 2022 •

edited

samuelmaddock left a comment

carterbs commented Oct 25, 2022 via email

samuelmaddock left a comment

nornagon left a comment

jkleinsc left a comment

release-clerk bot commented Nov 1, 2022

VerteDinde commented Nov 18, 2022

trop bot commented Nov 18, 2022

trop bot commented Nov 18, 2022

miniak commented Feb 2, 2023

trop bot commented Feb 2, 2023

trop bot commented Feb 2, 2023

feat: Add BrowserWindow option to hide window in Mission Control (macOS) #36092

feat: Add BrowserWindow option to hide window in Mission Control (macOS) #36092

Conversation

carterbs commented Oct 20, 2022 • edited

Description of Change

Checklist

Release Notes

nornagon left a comment

Choose a reason for hiding this comment

carterbs commented Oct 24, 2022 • edited

samuelmaddock left a comment

Choose a reason for hiding this comment

carterbs commented Oct 25, 2022 via email

samuelmaddock left a comment

Choose a reason for hiding this comment

nornagon left a comment

Choose a reason for hiding this comment

jkleinsc left a comment

Choose a reason for hiding this comment

release-clerk bot commented Nov 1, 2022

VerteDinde commented Nov 18, 2022

trop bot commented Nov 18, 2022

trop bot commented Nov 18, 2022

miniak commented Feb 2, 2023

trop bot commented Feb 2, 2023

trop bot commented Feb 2, 2023

carterbs commented Oct 20, 2022 •

edited

carterbs commented Oct 24, 2022 •

edited