Add Spec for IsWindowControlsOverlayEnabled.md #4613
Conversation
tochukwuIbeEkeocha
added
the
API Proposal Review
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
2038eac to
e886ba5
Compare
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
2 times, most recently
from
657def7 to
d395730
Compare
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
7 times, most recently
from
3866c89 to
bce67e9
Compare
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
bce67e9 to
700ec3a
Compare
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
700ec3a to
654b176
Compare
|
Is there any ETA on when this update might come to webview2? |
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
654b176 to
5a4eb5f
Compare
Co-authored-by: David Risney <dave@deletethis.net>
Co-authored-by: David Risney <dave@deletethis.net>
Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>
Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>
Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>
Co-authored-by: David Risney <dave@deletethis.net>
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
2f02f47 to
b38a178
Compare
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
b38a178 to
a6cc969
Compare
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
a6cc969 to
01a2caf
Compare
|
|
||
| CoreWebView2WindowControlsOverlaySettings config = Webview2.CoreWebivew2.WindowControlsOverlaySettings; | ||
| config.IsEnabled = true; | ||
| config.color = Color.FromARGB(0, 0, 255); |
There was a problem hiding this comment.
Does the order of setting these properties matter? If I set enabled=true before setting .color might there be a frame rendered of the overlay with the default color?
There was a problem hiding this comment.
Please update docs to say when does the IsEnabled change take affect - immediate or batched once the UI thread has a chance to work.
Prefer: the order shouldn't matter. If order matters we'll follow up.
| /// | ||
| /// When using this you should configure your app window to not display its default | ||
| /// window control buttons. You are responsible for creating a title bar for your app | ||
| /// by using the available space to the left of the controls overlay. In doing so, |
There was a problem hiding this comment.
Is this right or left conditional on the reading direction of the UI root?
There was a problem hiding this comment.
Please document what happens for RTL locales - does the controls overlay render on the left instead of right?
In the text here say 'before' instead of 'left'
There was a problem hiding this comment.
In RTL locales, the caption buttons still appear on the right side of the window, just like in LTR. The ordering of the buttons themselves is mirrored (Close | Maximize | Minimize), but their position remains on the right side of the window.
keeping that in mind 'left' actually fits correctly in the statement? please let me know if you still want it to be 'before' ?
|
|
||
| /// The `TitleBarBackgroundColor` property allows you to set a background color | ||
| /// for the overlay. Based on the background color you choose, Webview2 | ||
| ///will automatically calculate a foreground and hover color that will |
There was a problem hiding this comment.
Is foreground color necessarily black or white? We might be leaving this undocumented to reserve the right to choose colors based on the hosting app?
There was a problem hiding this comment.
They won't be white/black it will be based on the background color.
It would be helpful to include some screenshots of examples.
|
|
||
| CoreWebView2WindowControlsOverlaySettings config = Webview2.CoreWebivew2.WindowControlsOverlaySettings; | ||
| config.IsEnabled = true; | ||
| config.color = Color.FromARGB(0, 0, 255); |
There was a problem hiding this comment.
Please update docs to say when does the IsEnabled change take affect - immediate or batched once the UI thread has a chance to work.
Prefer: the order shouldn't matter. If order matters we'll follow up.
| [propget] HRESULT Height([out, retval] UINT32* value); | ||
|
|
||
|
|
||
| /// The `Height` property in raw screen pixels, allows you to set the height of the overlay and |
There was a problem hiding this comment.
@bradp0721 Does it make sense to use raw screen pixels here vs view pixels?
Also, we should ensure that different DPI awareness doesn't create bugs with real raw pixels vs virtual DPI scaled raw pixels.
| /// for the overlay. Based on the background color you choose, Webview2 | ||
| ///will automatically calculate a foreground and hover color that will | ||
| /// provide you the best contrast while maintaining accessibility. | ||
| /// Defaults to #f3f3f3. This API supports transparency. |
There was a problem hiding this comment.
Document that it does not support changing the default color or default height for OS theming (dark/light mode and high contrast) and height.
|
|
||
| /// The `TitleBarBackgroundColor` property allows you to set a background color | ||
| /// for the overlay. Based on the background color you choose, Webview2 | ||
| ///will automatically calculate a foreground and hover color that will |
There was a problem hiding this comment.
They won't be white/black it will be based on the background color.
It would be helpful to include some screenshots of examples.
Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>
Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>
Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>
Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>
Co-authored-by: David Risney <dave@deletethis.net>
Co-authored-by: David Risney <dave@deletethis.net>
Co-authored-by: David Risney <dave@deletethis.net>
What
These new APIs introduce support for a Webview2 Window Controls Overlay. The Window Controls Overlay will allow developers to build apps in webview2 with 100% of the UI controlled by the browser process. Devs will be able to create their apps as borderless & caption-less windows, and have the Webview draw its own window control buttons (minimize,maximize, close, restore).