-
Notifications
You must be signed in to change notification settings - Fork 550
Diagram relation of WebView2 control, SDK, & Runtime #2450
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
e98ad5d
b9c34a2
a6fddf4
5c871a6
ddf7797
bcfa65d
176e5b3
21528ff
edcf400
d76e62c
84617df
93be2bf
1e4ecca
47f2572
37ed9d2
f50c324
34b333d
5f948a2
46671d5
d35342b
7d42bf4
08eb77a
7ae9651
fff9e8b
ed6925b
8c9ff2f
053208d
a0f3751
db0addb
4e75447
575c785
0769e25
f986ae8
eb64192
7016915
4792113
deab4fb
c7121d5
4c28508
ae16e41
0ad4f52
a46b9b0
a21f9d0
d79f7a7
6c7d940
3912862
6d2ec16
c6d2ed4
6130440
1ad986a
e0c5418
924ec27
ea8293e
1e945f4
8777ed7
7e58c2b
61d7af2
ab15a0d
c895971
4e77133
d986e6f
ad7ac45
1bd040b
a2980b5
fea1b13
e83c4c1
7425f0d
dae5d12
4cdbba7
6ae4ff8
56a29e0
cba0099
ba2e44d
7174c1a
bee731d
ea20e46
6aa3ba9
91c526b
31d9cfd
6cb95c1
153670a
55f7c27
ade7003
5386527
21b7546
cceda3d
8acfb77
c599dea
2e4746b
03508ed
9b8e636
dada0f6
df0d487
a020c45
f0517cf
41ab52e
abc57f8
dc10ea3
50dc731
5c97fe3
40b0954
24d2dbd
a7c1d45
d7a6d92
ab5037e
73a23de
6d17575
1dd7f81
f6cfa0f
20e1d06
2f73708
0e559c3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,9 +19,33 @@ When distributing your WebView2 app, make sure that the WebView2 Runtime is pres | |
|
|
||
| For introductory information, see [Evergreen vs. fixed version of the WebView2 Runtime](./evergreen-vs-fixed-version.md). | ||
|
|
||
| **Detailed contents:** | ||
| * [Introductory notes](#introductory-notes) | ||
| * [Servicing the WebView2 Runtime through Windows Server Update Services (WSUS)](#servicing-the-webview2-runtime-through-windows-server-update-services-wsus) | ||
| * [Runtime or browser support during development or production](#runtime-or-browser-support-during-development-or-production) | ||
| * [Microsoft Edge Stable channel isn't supported for WebView2](#microsoft-edge-stable-channel-isnt-supported-for-webview2) | ||
| * [The Evergreen Runtime distribution mode](#the-evergreen-runtime-distribution-mode) | ||
| * [Windows 11 devices and Windows 10 devices (details)](#windows-11-devices-and-windows-10-devices-details) | ||
| * [Deploying the Evergreen WebView2 Runtime](#deploying-the-evergreen-webview2-runtime) | ||
| * [Installing the Runtime as per-machine or per-user](#installing-the-runtime-as-per-machine-or-per-user) | ||
| * [Detect if a WebView2 Runtime is already installed](#detect-if-a-webview2-runtime-is-already-installed) | ||
| * [Online-only deployment](#online-only-deployment) | ||
| * [Offline deployment](#offline-deployment) | ||
| * [Handle Evergreen WebView2 Runtime updates](#handle-evergreen-webview2-runtime-updates) | ||
| * [Test your app for forward-compatibility](#test-your-app-for-forward-compatibility) | ||
| * [Feature-detect when using recent APIs](#feature-detect-when-using-recent-apis) | ||
| * [The Fixed Version runtime distribution mode](#the-fixed-version-runtime-distribution-mode) | ||
| * [Known issues for Fixed Version](#known-issues-for-fixed-version) | ||
| * [Files to ship with the app](#files-to-ship-with-the-app) | ||
| * [See also](#see-also) | ||
|
|
||
|
|
||
| <!-- ====================================================================== --> | ||
| ## Introductory notes | ||
|
|
||
|
|
||
| <!-- ------------------------------ --> | ||
| #### Servicing the WebView2 Runtime through Windows Server Update Services (WSUS)<!-- todo: deprecated --> | ||
| #### Servicing the WebView2 Runtime through Windows Server Update Services (WSUS)<!-- todo: deprecated; modify? --> | ||
|
|
||
| See [Windows Server Update Services (WSUS)](./enterprise.md#windows-server-update-services-wsus) in _Enterprise management of WebView2 Runtimes_. | ||
|
|
||
|
|
@@ -77,9 +101,9 @@ For introductory information, see [Windows 11 devices and Windows 10 devices](./ | |
|
|
||
| The vast majority of Windows 10 devices have the WebView2 Runtime installed already, as described in [Delivering Microsoft Edge WebView2 Runtime to managed Windows 10 devices](https://blogs.windows.com/msedgedev/2022/12/14/delivering-microsoft-edge-webview2-runtime-to-managed-windows-10-devices/). A small number of Windows 10 devices don't have the WebView2 Runtime installed. We recommend that you handle this edge case, by using either of the following approaches: | ||
|
|
||
| * Programmatically deploy the Evergreen Runtime with your app. See [Deploying the Evergreen WebView2 Runtime](#deploying-the-evergreen-webview2-runtime) below. | ||
| * Programmatically deploy the Evergreen Runtime with your app. See [Deploying the Evergreen WebView2 Runtime](#deploying-the-evergreen-webview2-runtime) below. | ||
|
|
||
| * Redirect your end users to the Microsoft site: [Download Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2/consumer/), and have end users download the Evergreen WebView2 Runtime installer from the site and install the Runtime themselves. | ||
| * Redirect your end users to the Microsoft site: [Download Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2/consumer/), and have end users download the Evergreen WebView2 Runtime installer from the site and install the Runtime themselves. | ||
|
|
||
| See also: | ||
| * [Prerelease and Release SDKs for WebView2](./versioning.md) - Use a Prerelease version of the SDK along with a preview channel of Microsoft Edge; or use a Release version of the SDK along with the Evergreen WebView2 Runtime. | ||
|
|
@@ -90,15 +114,15 @@ See also: | |
|
|
||
| Only one installation of the Evergreen WebView2 Runtime is needed for all Evergreen apps on the device. Several tools are available at [Download the WebView2 Runtime](https://developer.microsoft.com/microsoft-edge/webview2#download-the-webview2-runtime) to help you deploy the Evergreen Runtime. | ||
|
|
||
| * For online clients: _WebView2 Runtime Bootstrapper_ is a tiny (approximately 2 MB) installer. The WebView2 Runtime Bootstrapper downloads and installs the Evergreen Runtime from Microsoft servers that matches the user's device architecture. | ||
| * For online clients: _WebView2 Runtime Bootstrapper_ is a tiny (approximately 2 MB) installer. The WebView2 Runtime Bootstrapper downloads and installs the Evergreen Runtime from Microsoft servers that matches the user's device architecture. | ||
|
|
||
| * In the setup part of your WebView2 app, link to the bootstrapper. Use a link to programmatically download the bootstrapper; select the **Get the Link** button at the above download page. | ||
| * In the setup part of your WebView2 app, link to the bootstrapper. Use a link to programmatically download the bootstrapper; select the **Get the Link** button at the above download page. | ||
|
|
||
| * Or, download the bootstrapper and package it with your WebView2 app. | ||
| * Or, download the bootstrapper and package it with your WebView2 app. | ||
|
|
||
| * For offline clients: _WebView2 Runtime Standalone Installer_ is a full installer that installs the Evergreen WebView2 Runtime in offline environments. | ||
| * For offline clients: _WebView2 Runtime Standalone Installer_ is a full installer that installs the Evergreen WebView2 Runtime in offline environments. | ||
|
|
||
| * If you're using App Installer to deploy MSIX applications, you can specify the WebView2 Runtime as a dependency, to have it be installed with the application.<!-- (instead of using the Evergreen Bootstrapper, Evergreen Standalone Installer, or Fixed Version (Self-Contained) distribution).--> For details about how to do this, see [win32dependencies:ExternalDependency (Windows 10, Windows 11)](/uwp/schemas/appxpackage/uapmanifestschema/element-win32dependencies-externaldependency) in the App package manifest docs. See also [Install Windows 10 apps with App Installer](/windows/msix/app-installer/app-installer-root). | ||
| * If you're using App Installer to deploy MSIX applications, you can specify the WebView2 Runtime as a dependency, to have it be installed with the application.<!-- (instead of using the Evergreen Bootstrapper, Evergreen Standalone Installer, or Fixed Version (Self-Contained) distribution).--> For details about how to do this, see [win32dependencies:ExternalDependency (Windows 10, Windows 11)](/uwp/schemas/appxpackage/uapmanifestschema/element-win32dependencies-externaldependency) in the App package manifest docs. See also [Install Windows 10 apps with App Installer](/windows/msix/app-installer/app-installer-root). | ||
|
|
||
|
|
||
| <!-- ------------------------------ --> | ||
|
|
@@ -224,6 +248,13 @@ To use the new version of the WebView2 Runtime, you need to either release all r | |
|
|
||
| In the Evergreen distribution mode, the WebView2 Runtime is automatically kept up to date on the client to provide the latest features and security fixes. If you use Evergreen distribution, to ensure that your WebView2 app stays compatible with the web, you should set up testing infrastructure. | ||
|
|
||
| Microsoft Edge preview channels (Beta, Dev, and Canary) provide a sneak peek into what is coming next in the WebView2 Runtime. Test your WebView2 app regularly against a Microsoft Edge preview channel, and update your app or [report issues](https://github.com/MicrosoftEdge/WebViewFeedback) if issues arise. See [Test upcoming APIs and features](../how-to/set-preview-channel.md). | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Trying to remember why these 3 paragraphs got added. They don't seem to be copied from an equivalent article. They look like might be appropriate.
The answer is probably in one of these two added links: |
||
| Canary is the recommended preview channel, because it ships at the fastest cadence and has the newest APIs. | ||
|
|
||
| To help you decide which channel is right, see [Overview of the Microsoft Edge channels](/deployedge/microsoft-edge-channels). You can [Download Microsoft Edge Insider Channels](https://www.microsoft.com/edge/download/insider) on your test environment, and use `regkey` or environment variables to indicate the channel preference for your testing app. | ||
|
|
||
| See [CreateCoreWebView2EnvironmentWithOptions](/microsoft-edge/webview2/reference/win32/webview2-idl#createcorewebview2environmentwithoptions). You can also use WebDriver to automate WebView2 testing, as described in [Automate, and test WebView2 with Microsoft Edge WebDriver](../how-to/webdriver.md). | ||
|
|
||
| For best practices about how to test your app for forward-compatibility, see [Prerelease testing using preview channels](../how-to/prerelease-testing.md) and [Self-host by deploying preview channels](../how-to/self-hosting.md). | ||
|
|
||
|
|
||
|
|
||

Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Heading is about a deprecated tool, Windows Server Update Services (WSUS). Modify, delete?
@captainbrosset
https://review.learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution?branch=pr-en-us-2450&tabs=dotnetcsharp#servicing-the-webview2-runtime-through-windows-server-update-services-wsus