Skip to content
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

Redesign WebView2 TOC & clarify article titles #3124

Open
wants to merge 49 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 45 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
caeaca8
start updating toc from pr 2725
mikehoffms Apr 9, 2024
c019f7e
Apply changes from PR 2725
mikehoffms Apr 10, 2024
77347df
show more full titles in toc
mikehoffms Apr 11, 2024
0028215
move deploy samples to deploy toc bucket
mikehoffms Apr 11, 2024
f292062
consistent article titles for samples
mikehoffms Apr 11, 2024
c9436a9
promote "Web and native interop" in TOC
mikehoffms Apr 11, 2024
9da2e53
Working with --> Use
mikehoffms Apr 11, 2024
fb98d26
catch up What's New's w/ "main"
mikehoffms Apr 11, 2024
d3771ce
move What's New 113 to Archive, like in "main"
mikehoffms Apr 11, 2024
ba4dcb1
Merge branch 'main' into wv2-toc
mikehoffms Apr 17, 2024
4f60074
Merge branch 'main' into wv2-toc
mikehoffms Apr 22, 2024
ac654b1
Merge branch 'main' into wv2-toc
mikehoffms Apr 25, 2024
0f49a9d
Merge branch 'main' into wv2-toc
mikehoffms Apr 30, 2024
67e7d85
Merge branch 'main' into wv2-toc
mikehoffms May 16, 2024
d1a7b4b
Merge branch 'main' into wv2-toc
mikehoffms May 22, 2024
a257117
Merge branch 'main' into wv2-toc
mikehoffms May 23, 2024
6e53a53
Merge branch 'main' into wv2-toc
mikehoffms May 29, 2024
e614712
Merge branch 'main' into wv2-toc
mikehoffms Jul 11, 2024
9798425
Merge branch 'main' into wv2-toc
mikehoffms Jul 19, 2024
eb8b196
Merge branch 'main' into wv2-toc
mikehoffms Jul 25, 2024
94f885b
Merge branch 'main' into wv2-toc
mikehoffms Jul 25, 2024
875a6c1
Merge branch 'main' into wv2-toc
mikehoffms Aug 8, 2024
fc9242b
Merge branch 'main' into wv2-toc
mikehoffms Aug 14, 2024
431fe8f
Merge branch 'main' into wv2-toc
mikehoffms Aug 20, 2024
ecd0f72
Merge branch 'main' into wv2-toc
mikehoffms Aug 26, 2024
1fd3848
Merge branch 'main' into wv2-toc
mikehoffms Sep 3, 2024
df4501c
Merge branch 'main' into wv2-toc
mikehoffms Sep 16, 2024
8bac0cf
Merge branch 'main' into wv2-toc
mikehoffms Sep 20, 2024
549330a
Merge branch 'main' into wv2-toc
mikehoffms Oct 10, 2024
43738e4
Samples before GetStarts
mikehoffms Oct 16, 2024
f070081
Merge branch 'main' into wv2-toc
mikehoffms Oct 16, 2024
20bbb3b
Merge branch 'main' into wv2-toc
mikehoffms Oct 25, 2024
8c279fb
sequence of samples to install/run
mikehoffms Oct 28, 2024
99e945e
adjust/trim list
mikehoffms Oct 28, 2024
f0890c4
can read
mikehoffms Oct 30, 2024
9edbd7b
Merge branch 'main' into wv2-toc
mikehoffms Nov 4, 2024
647deab
Merge branch 'main' into wv2-toc
mikehoffms Nov 7, 2024
5d72723
group sample w/ getstart per plat
mikehoffms Nov 7, 2024
e357d7c
plats bucket
mikehoffms Nov 7, 2024
85dd82e
Platforms
mikehoffms Nov 7, 2024
09b2c9f
Platforms and samples
mikehoffms Nov 7, 2024
cedd5f2
demote roadmap
mikehoffms Nov 13, 2024
241be23
group nav, events, auth
mikehoffms Nov 13, 2024
d68781b
fix dbl-nested Debug
mikehoffms Nov 13, 2024
dcf0ce7
process/threading model
mikehoffms Nov 13, 2024
31fecef
cmts to del debug.md in new PR
mikehoffms Nov 13, 2024
efb6b73
overviewapis
mikehoffms Nov 13, 2024
e10d541
restore Best practices bucket
mikehoffms Nov 13, 2024
90a8482
2 Test buckets
mikehoffms Nov 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion microsoft-edge/developer/index.yml
mikehoffms marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create a separate PR to propose deleting wv2's debug.md.

  • That used to contain single tabset containing 3 separate articles, which became 3 .md's.
  • No article links to here.

Propagate parts of its lead-in to top of the 3 child articles.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create a separate PR to propose deleting Roadmap.md

Copy link
Contributor Author

@mikehoffms mikehoffms Nov 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'll make sure no article was dropped (a periodic check):
walk through live rendered TOC, find article in PR's rendered TOC

Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ landingContent:
url: ../webview2/get-started/get-started.md
- linkListType: download
links:
- text: Sample Code
- text: WebView2 sample apps
url: ../webview2/code-samples-links.md
- linkListType: whats-new
links:
Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ conceptualContent:
url: ./webview2/get-started/get-started.md
itemType: get-started

- text: Sample Code
- text: WebView2 sample apps
url: ./webview2/code-samples-links.md
itemType: download

Expand Down
426 changes: 211 additions & 215 deletions microsoft-edge/toc.yml

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions microsoft-edge/webview2/code-samples-links.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sample apps
title: WebView2 sample apps
description: Sample apps for WebView2, for various frameworks or platforms including WinUI 2 (UWP), WinUI 3 (Windows App SDK), WPF, WPF with Chrome DevTools Protocol extension, WinForms, Win32/C++, and Win32 with Visual Composition.
author: MSEdgeTeam
ms.author: msedgedevrel
Expand All @@ -8,7 +8,7 @@ ms.service: microsoft-edge
ms.subservice: webview
ms.date: 08/29/2022
---
# Sample apps
# WebView2 sample apps


<!-- ====================================================================== -->
Expand Down Expand Up @@ -49,3 +49,4 @@ For some frameworks or platforms, the samples repo contains both a completed Get
## See also

* [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples#readme)
* [WebView2 deployment samples](./samples/deployment-samples.md)
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/concepts/frames.md
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ The following features, listed in [Overview of WebView2 features and APIs](./ove
<!-- ====================================================================== -->
## See also

* [Call native-side code from web-side code](../how-to/hostobject.md)
* [Interop of native and web code](../how-to/hostobject.md)
* [Navigation events for WebView2 apps](./navigation-events.md) - valid for frames as well as webpages.

**External pages:**
Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/concepts/navigation-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ For example code showing how to handle navigation events, see:
* [Step 8 - Navigation events](../get-started/winforms.md#step-8---navigation-events) in _Get started with WebView2 in WinForms apps_.
* [Step 13 - Navigation events](../get-started/win32.md#step-13---navigation-events) in _Get started with WebView2 in Win32 apps_.

The WebView2 [Sample apps](../code-samples-links.md) also demonstrate handling navigation events.
The [WebView2 sample apps](../code-samples-links.md) also demonstrate handling navigation events.


<!-- ====================================================================== -->
Expand Down
4 changes: 2 additions & 2 deletions microsoft-edge/webview2/concepts/overview-features-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Common use cases for web/native interop:
* Run a dedicated JavaScript file on the web side of an application.

See also:
* [Interop of native-side and web-side code](../how-to/communicate-btwn-web-native.md)
* [Interop of native and web code](../how-to/communicate-btwn-web-native.md)
* [Call web-side code from native-side code](../how-to/javascript.md)
* [Call native-side code from web-side code](../how-to/hostobject.md)
* [Call native-side WinRT code from web-side code](../how-to/winrt-from-js.md)
Expand Down Expand Up @@ -1970,7 +1970,7 @@ These APIs load, stop loading, and reload content to WebView2. The content that
* Content from a constructed network request.

See also:
* [Working with local content in WebView2 apps](./working-with-local-content.md)
* [Use local content in WebView2 apps](./working-with-local-content.md)

##### [.NET/C#](#tab/dotnetcsharp)

Expand Down
6 changes: 3 additions & 3 deletions microsoft-edge/webview2/concepts/process-related-events.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Handling process-related events in WebView2
title: Handle process-related events in WebView2
description: Process-related events in WebView2 and how apps can handle them for recovery and improved reliability.
author: MSEdgeTeam
ms.author: msedgedevrel
Expand All @@ -8,9 +8,9 @@ ms.service: microsoft-edge
ms.subservice: webview
ms.date: 07/13/2023
---
# Handling process-related events in WebView2
# Handle process-related events in WebView2

WebView2 uses multiple processes to support the WebView2 controls in your application. Because these processes can exit during use, WebView2 provides the `CoreWebView2.ProcessFailed` and `CoreWebView2Environment.BrowserProcessExited` events for your application to react to different scenarios. Use this document to learn how to use these events to react when these scenarios occur.
WebView2 uses multiple processes to support the WebView2 controls in your application. Because these processes can exit during use, WebView2 provides the `CoreWebView2.ProcessFailed` and `CoreWebView2Environment.BrowserProcessExited` events. Have your app use these events as follows, to react when these scenarios occur.

To improve the reliability of your WebView2 application, it is recommended that your app handles at least the following events:
* [The main browser process has exited unexpectedly](#the-main-browser-process-has-exited-unexpectedly).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Working with local content in WebView2 apps
title: Use local content in WebView2 apps
description: Ways to work with local content in WebView2 apps, including navigating to a file URL, navigating to a string, virtual host name mapping, or the WebResourceRequested event.
author: MSEdgeTeam
ms.author: msedgedevrel
Expand All @@ -8,7 +8,7 @@ ms.service: microsoft-edge
ms.subservice: webview
ms.date: 04/10/2024
---
# Working with local content in WebView2 apps
# Use local content in WebView2 apps

In addition to loading remote content, content can also be loaded locally into WebView2. There are several approaches that can be used to load local content into a WebView2 control, including:
* Navigating to a file URL.
Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/get-started/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ These articles cover how to set up your development tools and create an initial
## See also

* [Microsoft Edge WebView2](https://developer.microsoft.com/microsoft-edge/webview2) - initial introduction to WebView2, at `developer.microsoft.com`.
* [Sample apps](../code-samples-links.md) - framework-specific sample apps that showcase more of the WebView2 APIs than the Getting Started tutorials.
* [WebView2 sample apps](../code-samples-links.md) - framework-specific sample apps that showcase more of the WebView2 APIs than the Getting Started tutorials.
* [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples#readme) - contains completed Visual Studio projects that result from following the steps in these Getting Started tutorials, as well as sample apps and deployment samples.
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/get-started/win32.md
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,6 @@ Congratulations, you've built a Win32 app that hosts and uses the WebView2 contr
<!-- ====================================================================== -->
## See also

* [Sample Code for WebView2](../code-samples-links.md)
* [WebView2 sample apps](../code-samples-links.md)
* [Windows Runtime C++ Template Library (WRL)](/cpp/cppcx/wrl/windows-runtime-cpp-template-library-wrl?view=vs-2019&preserve-view=true)
* [Windows Implementation Libraries (WIL)](https://github.com/Microsoft/wil) GitHub repo.
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/get-started/winui.md
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ See [WinAppSDK supports custom WebView2 environments](#winappsdk-supports-custom
* [WebView2 API Reference](../webview2-api-reference.md)
* [Introduction to Microsoft Edge WebView2](../index.md) - overview of features.
* [Manage user data folders](../concepts/user-data-folder.md)
* [Sample Code for WebView2](../code-samples-links.md) - a guide to the `WebView2Samples` repo.
* [WebView2 sample apps](../code-samples-links.md) - a guide to the `WebView2Samples` repo.
* [Development best practices for WebView2 appsDevelopment best practices](../concepts/developer-guide.md)

developer.microsoft.com:
Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/get-started/winui2.md
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ The following classes aren't accessible in WinUI 2:
* [WebView2 API Reference](../webview2-api-reference.md)
* [WinUI 2 (UWP) sample app](../samples/webview2_sample_uwp.md) - steps to download, update, build, and run the WinUI 2 WebView2 sample.
* [Manage user data folders](../concepts/user-data-folder.md)
* [Sample Code for WebView2](../code-samples-links.md) - a guide to the `WebView2Samples` repo.
* [WebView2 sample apps](../code-samples-links.md) - a guide to the `WebView2Samples` repo.
* [Development best practices for WebView2 apps](../concepts/developer-guide.md)

GitHub:
Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/get-started/wpf.md
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ developer.microsoft.com:
Local pages:
* [WPF sample app](../samples/webview2wpfbrowser.md)
* [Manage user data folders](../concepts/user-data-folder.md)
* [Sample Code for WebView2](../code-samples-links.md) - a guide to the `WebView2Samples` repo.
* [WebView2 sample apps](../code-samples-links.md) - a guide to the `WebView2Samples` repo.
* [Development best practices for WebView2 apps](../concepts/developer-guide.md)

GitHub:
Expand Down
6 changes: 3 additions & 3 deletions microsoft-edge/webview2/how-to/communicate-btwn-web-native.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Interop of native-side and web-side code
title: Interop of native and web code
description: Embed web content into native applications using WebView2.
author: MSEdgeTeam
ms.author: msedgedevrel
Expand All @@ -8,7 +8,7 @@ ms.service: microsoft-edge
ms.subservice: webview
ms.date: 2/24/2022
---
# Interop of native-side and web-side code
# Interop of native and web code

The Microsoft Edge WebView2 control lets you embed web content into native applications. You can use WebView2 in different ways, depending on what you need to accomplish. This article describes how to communicate using simple messages, JavaScript code, and native objects.

Expand All @@ -23,7 +23,7 @@ Some common use cases include:

This tutorial steps through the Sample App code to demonstrate some of the communication capabilities in WebView2. Clone the [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples), open a `.sln` file in Visual Studio, build the project, and run (debug) to follow along with the steps in this article.

For detailed steps about cloning the repo, see [WebView2 samples](../code-samples-links.md).
For detailed steps about cloning the repo, see [WebView2 sample apps](../code-samples-links.md).


<!-- ====================================================================== -->
Expand Down
6 changes: 3 additions & 3 deletions microsoft-edge/webview2/how-to/customize-ui.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Customizing the UI in WebView2 apps
description: Customizing the UI in WebView2 apps. Add custom right-click menus (context menus) to a WebView2 app, or add and remove items from the default WebView2 context menus.
title: Customize the UI in WebView2 apps
description: How to add custom right-click menus (context menus) to a WebView2 app, or add and remove items from the default WebView2 context menus.
author: MSEdgeTeam
ms.author: msedgedevrel
ms.topic: conceptual
ms.service: microsoft-edge
ms.subservice: webview
ms.date: 02/08/2022
---
# Customizing the UI in WebView2 apps
# Customize the UI in WebView2 apps

<!-- presently omitted from TOC -->

Expand Down
21 changes: 17 additions & 4 deletions microsoft-edge/webview2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ms.topic: conceptual
ms.service: microsoft-edge
ms.localizationpriority: high
ms.subservice: webview
ms.date: 10/31/2023
ms.date: 10/28/2024
---
# Introduction to Microsoft Edge WebView2

Expand All @@ -17,8 +17,6 @@ With WebView2, you can embed web code in different parts of your native app, or

![Diagram of an app with native UI areas in the left and top left, and WebView2 UI areas in the top right and bottom](./index-images/what-webview.png)

To start building a WebView2 app, see [Get started with WebView2](get-started/get-started.md).


<!-- ====================================================================== -->
## Hybrid app approach
Expand Down Expand Up @@ -108,11 +106,26 @@ See also:
* [Microsoft Edge and WebView2 ending support for Windows 7 and Windows 8/8.1](https://blogs.windows.com/msedgedev/2022/12/09/microsoft-edge-and-webview2-ending-support-for-windows-7-and-windows-8-8-1/)


<!-- ====================================================================== -->
## Sequence of samples to install and run

To start learning WebView2, use the following recommended sequence:

1. Install Visual Studio, install preview channels of Microsoft Edge, and clone the `WebView2Samples` repo. See [Set up your Dev environment for WebView2](./how-to/machine-setup.md).
1. Install and run the main sample. See [Win32 sample app](./samples/webview2apissample.md).
1. Install and run the sample for your target platform, if it's a platform other than Win32. See [Sample apps](./code-samples-links.md).
1. Install and run the finished Getting Started tutorial for your target platform (if the finished project is provided). See [Getting Started tutorials](./get-started/get-started.md).
1. Do the Getting Started steps to add WebView2 code to the Visual Studio starter project for your platform. See [Getting Started tutorials](./get-started/get-started.md).

Some samples might require updating an SDK, as explained in the article for each sample.

After your environment is set up and the samples build and run on your machine, you can develop your app by reading the other documentation, such as [Overview of WebView2 features and APIs](./concepts/overview-features-apis.md).


<!-- ====================================================================== -->
## See also

* [Overview of WebView2 features and APIs](concepts/overview-features-apis.md)
* [Getting Started tutorials](get-started/get-started.md)
* [Distribute your app and the WebView2 Runtime](concepts/distribution.md)

developer.microsoft.com:
Expand Down
5 changes: 3 additions & 2 deletions microsoft-edge/webview2/samples/deployment-samples.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Deployment samples
title: WebView2 deployment samples
description: Deployment samples for WebView2.
author: MSEdgeTeam
ms.author: msedgedevrel
Expand All @@ -8,7 +8,7 @@ ms.service: microsoft-edge
ms.subservice: webview
ms.date: 07/11/2022
---
# Deployment samples
# WebView2 deployment samples

These samples demonstrate how to deploy the Evergreen WebView2 Runtime with your app that uses the WebView2 control.

Expand All @@ -24,3 +24,4 @@ These samples demonstrate how to deploy the Evergreen WebView2 Runtime with your

* [Deploying the Evergreen WebView2 Runtime](../concepts/distribution.md#deploying-the-evergreen-webview2-runtime) in _Distribute your app and the WebView2 Runtime_.
* [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples#readme)
* [WebView2 sample apps](../code-samples-links.md)
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/samples/webview2apissample.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Next, you'll update the WebView2 SDK and then re-build the project.

If you want to quickly see which version of the WebView2 SDK is installed in the repo's copy of the **WebView2APISample** app at GitHub, see [packages.config](https://github.com/MicrosoftEdge/WebView2Samples/blob/main/SampleApps/WebView2APISample/packages.config).

The repo version of this sample has a prerelease version of the WebView2 SDK installed. Below, you'll update it to the latest prerelease version of the WebView2 SDK, or confirm that the latest SDK is installed. Using a prerelease SDK gives you access to the latest functionality.
The repo version of this sample has a Prerelease version of the WebView2 SDK installed. Below, you'll update it to the latest Prerelease version of the WebView2 SDK, or confirm that the latest SDK is installed. Using a Prerelease SDK gives you access to the latest functionality.

Examine and possibly update the installed NuGet packages, as follows:

Expand Down