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
from
e886ba5
to
657def7
Compare
tochukwuIbeEkeocha
force-pushed
the
api-isWindowControlsOverlayEnabled-draft
branch
from
657def7
to
d395730
Compare
|
|
||
|
|
||
| # Appendix | ||
| To provide your app users with the best experience, it is important to handle webview |
There was a problem hiding this comment.
Is this relevant to this API? If so it should be in the ref docs for the property or method. But it sort of sounds like its for something else?
| /// top right corner of the window. | ||
| /// | ||
| [propput] HRESULT IsWindowControlsOverlayEnabled([in] BOOL value); | ||
| } |
There was a problem hiding this comment.
Missing COM IDL for the controller method
| unsealed runtimeclass CoreWebView2Controller { | ||
| [interface_name("Microsoft.Web.WebView2.Core.ICoreWebView2Controller5")] | ||
| { | ||
| Windows.Foundation.Rect QueryWindowControlsOverlayBounds(); |
There was a problem hiding this comment.
Should this be a getter-only property instead of a method?
| { | ||
| InitializeComponent(); | ||
| this.webView2Control.CoreWebView2InitializationCompleted | ||
| += WebView2InitializationCompleted; |
There was a problem hiding this comment.
The indenting is off here and elsewhere
| object sender, | ||
| CoreWebView2NavigationCompletedEventArgs e) | ||
| { | ||
| Windows.Foundation.Rect bounds = CoreWebView2Controller.QueryWindowControlsOverlayBounds(); |
There was a problem hiding this comment.
You aren't doing anything with the bounds.
| private void SetWindowControlsOverlaySupport(bool enabled) | ||
| { | ||
| var coreWebView2Settings = this.webView2Control.CoreWebView2.Settings; | ||
| coreWebView2Settings.IsWindowControlsOverlayEnabled = enabled; |
There was a problem hiding this comment.
The sample code should show code that an end dev would write for a real app. We don't really need code that shows setting a property - but if you show setting the property in the correct context or correct way that would be helpful.
In this case it would probably be helpful to show when to set the overlayEnabled property (during startup? - would an end dev ever want to change the value after startup?) and also show how to use the QueryWindowControlsOverlayBounds to adjust web content so the web content isn't under the window overlay bounds.
| be rendered and controlled by the browser process. This API allows devs to tell | ||
| WebView2 that it should render its own window control buttons. | ||
|
|
||
| # Description |
There was a problem hiding this comment.
No need to repeat what you have in the ref docs here. The current template doesn't have a Description section.
| the entire Window UI is rendered by WebView2. Till now, it hasn't been possible | ||
| for the window/caption control buttons (minimize, maximize, restore, close) to | ||
| be rendered and controlled by the browser process. This API allows devs to tell | ||
| WebView2 that it should render its own window control buttons. |
There was a problem hiding this comment.
It would be good to add in the background section the notes about how this relates to previous APIs (that css property for a titlebar html element - related feature but they don't really interact) and how it relates to future APIs (you said future APIs will let them control the styling or something?)
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).