-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create CoreWebView2ControllerOptions.DefaultBackgroundColor.md
Update to address feedback from review comments
- Loading branch information
1 parent
0ba6096
commit bad09b9
Showing
1 changed file
with
124 additions
and
0 deletions.
There are no files selected for viewing
124 changes: 124 additions & 0 deletions
124
specs/CoreWebView2ControllerOptions.DefaultBackgroundColor.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
CoreWebView2ControllerOptions.DefaultBackgroundColor | ||
=== | ||
# Background | ||
|
||
Previously, there was a fix to address an issue where the background color controller property | ||
was applied too late, causing a disruptive white flash during the WebView2 loading process. | ||
|
||
This fix required using an environment variable. However, this workaround was not meant to be | ||
a long-term solution. Therefore, we need to add this setting to `ICoreWebView2ControllerOptions` | ||
to apply the color early in the loading process. | ||
|
||
# Description | ||
|
||
This interface extends the `ICoreWebView2ControllerOptions` to expose the `DefaultBackgroundColor` | ||
property as an option. | ||
The `CoreWebView2ControllerOptions.DefaultBackgroundColor` API allows users to set the | ||
`DefaultBackgroundColor` property at initialization. | ||
|
||
This is useful when setting it using the existing [`CoreWebView2Controller.DefaultBackgroundColor API`](https://learn.microsoft.com/en-us/dotnet/api/microsoft.web.webview2.core.corewebview2controller.defaultbackgroundcolor?view=webview2-dotnet-1.0.2792.45) | ||
applies the color too late. | ||
|
||
|
||
|
||
# Examples | ||
|
||
## Win32 C++ | ||
```cpp | ||
HRESULT AppWindow::CreateControllerWithOptions() | ||
{ | ||
wil::com_ptr<ICoreWebView2ControllerOptions> options; | ||
HRESULT hr = m_environment->CreateCoreWebView2ControllerOptions(&options); | ||
|
||
wil::com_ptr<ICoreWebView2ControllerOptions> stagingOptions; | ||
auto result = options->QueryInterface(IID_PPV_ARGS(&stagingOptions)); | ||
|
||
if (SUCCEEDED(result)) | ||
{ | ||
COREWEBVIEW2_COLOR wvColor{255, 223, 225, 225}; | ||
stagingOptions->put_DefaultBackgroundColor(wvColor); | ||
|
||
m_environment->CreateCoreWebView2Controller( | ||
m_mainWindow, options.Get(), | ||
Callback<ICoreWebView2CreateCoreWebView2ControllerCompletedHandler>( | ||
this, &AppWindow::OnCreateCoreWebView2ControllerCompleted).Get()); | ||
} | ||
|
||
} | ||
``` | ||
|
||
|
||
|
||
## C# | ||
```c# | ||
public MainWindow() | ||
{ | ||
InitializeComponent(); | ||
SetDefaultBackgroundColor(); | ||
} | ||
|
||
private void SetDefaultBackgroundColor() | ||
{ | ||
CoreWebView2ControllerOptions options = WebView2.CoreWebView2.Environment.CreateCoreWebView2ControllerOptions(); | ||
options.DefaultBackgroundColor = Color.FromArgb(0, 0, 255); | ||
WebView2.CoreWebView2.Environment.CreateCoreWebView2ControllerAsync(parentHwnd, options); | ||
} | ||
|
||
``` | ||
|
||
|
||
|
||
# API Details | ||
|
||
## Win32 C++ | ||
```cpp | ||
/// This interface extends the ICoreWebView2ControllerOptions interface to expose the DefaultBackgroundColor property. | ||
/// It is encouraged to transition away from the environment variable and use this API solution to apply the property. | ||
|
||
[uuid(df9cb70b-8d87-5bca-ae4b-6f23285e8d94), object, pointer_default(unique)] | ||
interface ICoreWebView2ControllerOptions4 : IUnknown { | ||
|
||
/// This API allows users to initialize the `DefaultBackgroundColor` early, | ||
/// preventing a white flash that can happen while WebView2 is loading when | ||
/// the background color is set to something other than white. With early | ||
/// initialization, the color remains consistent from the start. After | ||
/// initialization, `ICoreWebView2Controller2::get_DefaultBackgroundColor` | ||
/// will return the value set using this API. | ||
/// | ||
/// The `DefaultBackgroundColor` is the color that renders underneath all web | ||
/// content. This means WebView renders this color when there is no web | ||
/// content loaded. It is important to note that the default color is white. | ||
/// Currently this API only supports opaque colors and transparency. It will | ||
/// fail for colors with alpha values that don't equal 0 or 255 ie. translucent | ||
/// colors are not supported. It also does not support transparency on Windows 7. | ||
/// On Windows 7, setting DefaultBackgroundColor to a Color with an Alpha value | ||
/// other than 255 will result in failure. On any OS above Win7, choosing a | ||
/// transparent color will result in showing hosting app content. This means | ||
/// webpages without explicit background properties defined will render web | ||
/// content over hosting app content. | ||
|
||
[propget] HRESULT DefaultBackgroundColor([out, retval] COREWEBVIEW2_COLOR* value); | ||
[propput] HRESULT DefaultBackgroundColor([in] COREWEBVIEW2_COLOR value); | ||
|
||
} | ||
``` | ||
|
||
|
||
|
||
## .NET WinRT | ||
|
||
```cpp | ||
namespace Microsoft.Web.WebView2.Core | ||
{ | ||
runtimeclass CoreWebView2ControllerOptions | ||
{ | ||
// ... | ||
[interface_name("ICoreWebView2ControllerOptions4")] | ||
{ | ||
Windows.UI.Color DefaultBackgroundColor { get; set; }; | ||
} | ||
} | ||
} | ||
} | ||
|
||
``` |