Add support for focus mode #6804

zadjii-msft · 2020-07-06T20:36:45Z

Summary of the Pull Request

Add support for "focus" mode, which only displays the actual terminal content, no tabs or titlebar. The edges of the window are draggable to resize, but the window can't be moved in borderless mode.

The window looks slightly different bewteen different values for showTabsInTitlebar, because switching between the NonClientIslandWindow and the IslandWindow is hard.

`showTabsInTitlebar`	Preview
`true`
`false`

PR Checklist

Closes [Feature Request] Border-/Titleless windows for displaying dynamic information with the Terminal #2238
I work here
Tests added/passed
Requires documentation to be updated

Detailed Description of the Pull Request / Additional comments

KNOWN ISSUE: Upon resizing the NCIW, the top frame margin disappears, making that border disappear entirely. 6356aaf has a bunch of WIP work for me trying to fix that, but I couldn't get it quite right.

Validation Steps Performed

Toggled between focus and fullscreen a bunch in both modes.

…ess<->Fullscreen still

…rless in either mode. Now double check NCIW...

… an acceptable known issue, since the alternative is having a white line on top of the window when it loses focus

…ll-just-do-it-myself # Conflicts: # src/cascadia/TerminalApp/ActionAndArgs.cpp # src/cascadia/TerminalApp/AppActionHandlers.cpp # src/cascadia/TerminalApp/ShortcutActionDispatch.cpp # src/cascadia/TerminalApp/ShortcutActionDispatch.h # src/cascadia/TerminalApp/ShortcutActionDispatch.idl # src/cascadia/TerminalApp/TerminalPage.cpp # src/cascadia/TerminalApp/TerminalPage.h

…cally

miniksa

Handful of things I saw browsing through.

I know someone's going to whine that this isn't "truly" borderless because we're still going to have the 1px border around the window. It's more of frameless or chrome-less. It feels like a giant pain to change it all over, but now's probably the time to consider that before the setting is set.

(I know we briefly mentioned it in the sync meeting today, but I'm still worried about the "border" terminology.)

src/cascadia/WindowsTerminal/IslandWindow.cpp

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp

miniksa · 2020-07-06T20:54:44Z

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp

+// - <none>
+void NonClientIslandWindow::_SetIsBorderless(const bool borderlessEnabled)
+{
+    _borderless = borderlessEnabled;


Should we be testing on the way in that the state is actually changing before dispatching the window messages? Is there a way to set borderless = true on top of an already borderless window and dispatch a bunch of window messages that will make things jump around but end up back where they were in a weird way?

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp

carlos-zamora

I don't really have anything to add here. Really just everything Michael said. I guess I'll approve with suggestions? 🤷‍♂️

src/cascadia/TerminalApp/defaults.json

WSLUser · 2020-07-07T13:13:08Z

because we're still going to have the 1px border around the window

He's right. I think borderless and I think of how a few games appear that support the borderless mode (or game mods that enable the functionality). I doubt MUX is used (probably something in the DWRITE layer) so not sure how it's handled but might be worth investigating if we can get a truly borderless window. Otherwise I'd agree that calling it "chromeless" or "frameless" (preference) would be a better description.

Here's something that may help: https://stackoverflow.com/questions/43818022/borderless-window-with-drop-shadow Just ignore the GDI since this can still be mostly done using DirectX: https://docs.microsoft.com/en-us/windows/win32/direct3d12/directx-12-programming-guide

WSLUser · 2020-07-07T16:00:50Z

I would actually prefer completely borderless, usually there are some perf bonuses when switching between applications though not sure if that would be the case here. I do agree we'd need resizing and drop shadows. Any way we could do it in terminal/src/renderer/dx instead? Most of that SO code could likely be re-used but would require some plumbing to hook into the terminal settings (which we sort of already do for the retro terminal effect). I think it should be a bit more straightforward and less effort than attempting to do it in the Island Window.

zadjii-msft · 2020-07-07T16:06:55Z

It would be infinitely harder to do it in the DX layer. The DX layer is fully encapsulated in the SwapChainPanel, which is within the bounds of the XAML island. It's exclusively used for drawing the contents of a single terminal instance, and doesn't know anything about the window that's hosting it. We're definitely going to need to do this at a higher level than that.

We used to do the whole DwmExtendFrameIntoClient dance before, and it was a disaster that I absolutely hated, and the NCIW is way better off without it. I'm highly reluctant to reintroduce it lightly, even for something like this.

WSLUser · 2020-07-07T16:14:39Z

In that case, I'd say for now we just call it frameless mode and file a follow on to to get full borderless with resize and shadows still working (and throw a "Help Wanted" label on it).

DHowett · 2020-07-07T17:43:02Z

I’m not sure the use case for actual borderless mode really exists. It sounds like a strawman. :)

This one feels to me like a floating or detached mode. I’d rather we name it by what it accomplishes rather than how it accomplishes it...

carlos-zamora · 2020-07-07T18:26:49Z

@zadjii-msft Don't forget to update the docs and link the PR!

DHowett · 2020-07-09T23:23:21Z

So, pursuant to 610c267 (#6804).. are we going with a mode that suppresses resize and drop shadows? I'm not sure I like that.

zadjii-msft · 2020-07-10T12:21:01Z

So, pursuant to 610c267 (#6804).. are we going with a mode that suppresses resize and drop shadows? I'm not sure I like that.

Guh, I was supposed to revert that before pushing 🤦‍♂️

This reverts commit 610c267.

WSLUser · 2020-07-10T14:15:25Z

I hope one day we can enable that setting without losing resize and drop shadows.

zadjii-msft · 2020-07-10T14:26:42Z

We're definitely doing the mode with the resizing and the drop shadows. I mistakenly didn't revert the commit where I was playing around with the "frameless" version.

WSLUser · 2020-07-10T14:29:55Z

We shouldn't have to work around that setting. It's a reasonable expectation that functionality won't drop simply due to enabling the setting. Glad we could work around it though.

WSLUser · 2020-07-10T14:47:10Z

I filed an feature request so we can more easily set borderless mode with the xaml setting. That would hopefully replace much of what's here with a simpler, more elegant solution.

zadjii-msft · 2020-07-10T15:26:11Z

Wait what are you talking about? The ~~borderless~~ Focus Mode that's being implemented here is not "frameless, resizeless, shadowless" mode. It's exactly as in the OP. We're not doing anything with any sort of MUX or UWP borderless mode in this PR. We're just manually hiding the TabView. For the window with the Win32 titlebar, we're also setting some other window styles.

doc/cascadia/profiles.schema.json

src/cascadia/WindowsTerminal/IslandWindow.cpp

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp

DHowett

changing to NAK so github logs it

cinnamon-msft · 2020-07-10T23:47:34Z

For the default key binding, what do we think about Shift+F11?

DHowett · 2020-07-11T21:09:41Z

With the command palette, I'm not sure we need a default key binding right now. We can see if one grows organically!

src/cascadia/TerminalApp/Resources/en-US/Resources.resw

ghost · 2020-07-13T17:39:49Z

Hello @zadjii-msft!

Because this pull request has the AutoMerge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.

ghost · 2020-07-22T16:23:32Z

🎉Windows Terminal Preview v1.2.2022.0 has been released which incorporates this pull request.:tada:

Handy links:

NicTanghe · 2020-08-03T09:20:33Z

O M G this is awsome 💯

zadjii-msft added 6 commits June 26, 2020 11:25

Proof of concept, borderless for the NCIW. Need to do IW, and borderl…

d5fe651

…ess<->Fullscreen still

Now it works for the IW as well

e6c8b65

This feels good for all the IW scenarios - toggling both FS and borde…

95f4904

…rless in either mode. Now double check NCIW...

NCIW works _pretty_ well, but loses the top border on resize. This is…

6356aaf

… an acceptable known issue, since the alternative is having a white line on top of the window when it loses focus

cleanup for review

fcb2d48

ghost added Area-UserInterface Issues pertaining to the user interface of the Console or Terminal Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. Product-Terminal The new Windows Terminal. labels Jul 6, 2020

zadjii-msft added 3 commits July 6, 2020 15:37

add to defaults.json too, so it'll be picked up as a command automati…

a50d2e9

…cally

add to schema

f5a1a68

good bot

06506f2

miniksa reviewed Jul 6, 2020

View reviewed changes

carlos-zamora approved these changes Jul 6, 2020

View reviewed changes

src/cascadia/TerminalApp/defaults.json Outdated Show resolved Hide resolved

zadjii-msft mentioned this pull request Jul 7, 2020

Feature Request: Always On Top #3038

Closed

This comment has been minimized.

Sign in to view

this totally obliterates the frames, but I don't love it

610c267

zadjii-msft added 2 commits July 9, 2020 16:31

s/Borderless/FocusMode/g

e43e132

Hey this finally compiles again

2ed41e2

zadjii-msft changed the title ~~Add support for borderless mode~~ Add support for focus mode Jul 9, 2020

good bot

b9e9e01

Revert "this totally obliterates the frames, but I don't love it"

62c993d

This reverts commit 610c267.

WSLUser mentioned this pull request Jul 10, 2020

Proposal: Ability to resize and use drop shadows in borderless mode by default (no additional code) microsoft/microsoft-ui-xaml#2876

Open

how

38e198b

DHowett reviewed Jul 10, 2020

View reviewed changes

doc/cascadia/profiles.schema.json Outdated Show resolved Hide resolved

src/cascadia/WindowsTerminal/IslandWindow.cpp Outdated Show resolved Hide resolved

src/cascadia/WindowsTerminal/NonClientIslandWindow.cpp Outdated Show resolved Hide resolved

DHowett requested changes Jul 10, 2020

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jul 10, 2020

DHowett reviewed Jul 11, 2020

View reviewed changes

src/cascadia/TerminalApp/Resources/en-US/Resources.resw Show resolved Hide resolved

This is what I get for rushing to ship code on a friday

8ee0d59

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jul 13, 2020

zadjii-msft assigned DHowett Jul 13, 2020

DHowett approved these changes Jul 13, 2020

View reviewed changes

DHowett removed their assignment Jul 13, 2020

zadjii-msft added the AutoMerge Marked for automatic merge by the bot when requirements are met label Jul 13, 2020

ghost merged commit 1c8e83d into master Jul 13, 2020

ghost deleted the dev/migrie/f/2238-ill-just-do-it-myself branch July 13, 2020 17:40

eugenesvk mentioned this pull request Jul 18, 2020

[Feature Request] Border-/Titleless windows for displaying dynamic information with the Terminal #2238

Closed

zadjii-msft mentioned this pull request Jul 22, 2020

Really hard to resize via top margin when toggleFocusMode is enabled #7012

Closed

isolune mentioned this pull request Oct 9, 2020

Add command line flag to start in focus mode #7875

Closed

zadjii-msft mentioned this pull request May 11, 2021

Top of window border loses color after focus mode/full-screen #10052

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for focus mode #6804

Add support for focus mode #6804

zadjii-msft commented Jul 6, 2020 •

edited

Loading

miniksa left a comment

miniksa Jul 6, 2020

carlos-zamora left a comment

WSLUser commented Jul 7, 2020 •

edited

Loading

This comment has been minimized.

WSLUser commented Jul 7, 2020 •

edited

Loading

zadjii-msft commented Jul 7, 2020

WSLUser commented Jul 7, 2020

DHowett commented Jul 7, 2020

carlos-zamora commented Jul 7, 2020

DHowett commented Jul 9, 2020 •

edited

Loading

zadjii-msft commented Jul 10, 2020

WSLUser commented Jul 10, 2020

zadjii-msft commented Jul 10, 2020

WSLUser commented Jul 10, 2020 •

edited

Loading

WSLUser commented Jul 10, 2020 •

edited

Loading

zadjii-msft commented Jul 10, 2020

DHowett left a comment

cinnamon-msft commented Jul 10, 2020

DHowett commented Jul 11, 2020

ghost commented Jul 13, 2020

ghost commented Jul 22, 2020

NicTanghe commented Aug 3, 2020

Add support for focus mode #6804

Add support for focus mode #6804

Conversation

zadjii-msft commented Jul 6, 2020 • edited Loading

Summary of the Pull Request

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

miniksa left a comment

Choose a reason for hiding this comment

miniksa Jul 6, 2020

Choose a reason for hiding this comment

carlos-zamora left a comment

Choose a reason for hiding this comment

WSLUser commented Jul 7, 2020 • edited Loading

This comment has been minimized.

WSLUser commented Jul 7, 2020 • edited Loading

zadjii-msft commented Jul 7, 2020

WSLUser commented Jul 7, 2020

DHowett commented Jul 7, 2020

carlos-zamora commented Jul 7, 2020

DHowett commented Jul 9, 2020 • edited Loading

zadjii-msft commented Jul 10, 2020

WSLUser commented Jul 10, 2020

zadjii-msft commented Jul 10, 2020

WSLUser commented Jul 10, 2020 • edited Loading

WSLUser commented Jul 10, 2020 • edited Loading

zadjii-msft commented Jul 10, 2020

DHowett left a comment

Choose a reason for hiding this comment

cinnamon-msft commented Jul 10, 2020

DHowett commented Jul 11, 2020

ghost commented Jul 13, 2020

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

ghost commented Jul 22, 2020

NicTanghe commented Aug 3, 2020

zadjii-msft commented Jul 6, 2020 •

edited

Loading

WSLUser commented Jul 7, 2020 •

edited

Loading

WSLUser commented Jul 7, 2020 •

edited

Loading

DHowett commented Jul 9, 2020 •

edited

Loading

WSLUser commented Jul 10, 2020 •

edited

Loading

WSLUser commented Jul 10, 2020 •

edited

Loading

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (`@msftbot`) and give me an instruction to get started! Learn more here.