From caeaca8dfeb0e0cd2fda5552f72235abaca234a3 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Tue, 9 Apr 2024 10:03:54 -0700 Subject: [PATCH 01/25] start updating toc from pr 2725 --- microsoft-edge/toc.yml | 136 ++++++++++-------- .../webview2/how-to/customize-ui.md | 6 +- 2 files changed, 77 insertions(+), 65 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 0d8f301fce..684bc15ab1 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1190,6 +1190,9 @@ - name: Overview of WebView2 features and APIs href: webview2/concepts/overview-features-apis.md + - name: Differences between Microsoft Edge and WebView2 + href: webview2/concepts/browser-features.md + # ----------------------------------------------------------------------------- # machine setup - name: Set up your Dev environment for WebView2 @@ -1205,7 +1208,7 @@ - name: WinUI 2 (UWP) href: webview2/get-started/winui2.md - displayName: Get started with WebView2 in WinUI 2 (UWP) apps # no repo dir exists # top-of-page title + displayName: WinUI2_GettingStarted, Get started with WebView2 in WinUI 2 (UWP) apps # repo dir name # top-of-page title - name: WinUI 3 (Windows App SDK) href: webview2/get-started/winui.md @@ -1236,11 +1239,11 @@ - name: Win32 sample app href: webview2/samples/webview2apissample.md - displayName: WebView2APISample, SampleApps, Win32 sample app # repo dir names, top-of-page title + displayName: WebView2APISample, SampleApps # repo dir names - name: Win32 sample app with Visual Composition href: webview2/samples/webview2samplewincomp.md - displayName: WebView2SampleWinComp, Win32 sample app with Visual Composition # repo dir name, top-of-page title + displayName: WebView2SampleWinComp # repo dir name - name: Win32 sample WebView2Browser href: webview2/samples/webview2browser.md @@ -1248,16 +1251,16 @@ - name: WinUI 2 (UWP) sample app href: webview2/samples/webview2_sample_uwp.md - displayName: webview2_sample_uwp, WinUI 2 (UWP) sample app # repo dir name, top-of-page title + displayName: webview2_sample_uwp # repo dir name # pending, July 26 2022 -# - name: WinUI 3 sample app -# href: webview2/samples/webview2-winui3-sample.md -# displayName: WebView2_WinUI3_Sample # repo dir name +# - name: WinUI 3 sample app +# href: webview2/samples/webview2-winui3-sample.md +# displayName: WebView2_WinUI3_Sample # repo dir name - name: WPF sample app href: webview2/samples/webview2wpfbrowser.md - displayName: WebView2WpfBrowser, WPF sample app # repo dir name, top-of-page title + displayName: WebView2WpfBrowser # repo dir name - name: WPF sample app with CDP href: webview2/samples/wv2cdpextensionwpfsample.md @@ -1287,57 +1290,34 @@ displayName: WV2DeploymentWiXCustomActionSample # repo dir name # ----------------------------------------------------------------------------- - - name: Fundamentals - items: - - name: Differences between Microsoft Edge and WebView2 - href: webview2/concepts/browser-features.md +# top-level entries below Samples + - name: "Main classes for WebView2: Environment, Controller, and Core" + href: webview2/concepts/environment-controller-core.md - - name: WebView2 browser flags - href: webview2/concepts/webview-features-flags.md + - name: Navigation events + href: webview2/concepts/navigation-events.md + displayName: Navigation events for WebView2 apps # top-of-page title - - name: "Main classes for WebView2: Environment, Controller, and Core" - href: webview2/concepts/environment-controller-core.md + - name: Process-related events + href: webview2/concepts/process-related-events.md + displayName: Handling process-related events in WebView2 # top-of-page title - - name: Navigation events - href: webview2/concepts/navigation-events.md - displayName: Navigation events for WebView2 apps # top-of-page title + - name: Basic authentication + href: webview2/concepts/basic-authentication.md + displayName: auth, Basic authentication for WebView2 apps # top-of-page title - - name: Process-related events - href: webview2/concepts/process-related-events.md - displayName: Handling process-related events in WebView2 # top-of-page title + - name: Windowed vs. visual hosting of WebView2 + href: webview2/concepts/windowed-vs-visual-hosting.md - - name: Basic authentication - href: webview2/concepts/basic-authentication.md - displayName: auth, Basic authentication for WebView2 apps # top-of-page title - - - name: Windowed vs. visual hosting of WebView2 - href: webview2/concepts/windowed-vs-visual-hosting.md + - name: WebView2 browser flags + href: webview2/concepts/webview-features-flags.md + - name: Customization and UI + items: - name: Custom management of network requests href: webview2/how-to/webresourcerequested.md displayName: WebResourceRequested, WebResourceResponseReceived - - name: Web and native interop - items: - - name: Interop of native-side and web-side code - href: webview2/how-to/communicate-btwn-web-native.md - displayName: JavaScript interop, Embed web content into native applications (JavaScript interop) # old title - - - name: Call web-side code from native-side code - href: webview2/how-to/javascript.md - displayName: ExecuteScriptAsync API, Use JavaScript in WebView for extended scenarios # old title - - - name: Call native-side code from web-side code - href: webview2/how-to/hostobject.md - displayName: AddHostObjectToScript, host objects - - - name: Call native-side WinRT code from web-side code - href: webview2/how-to/winrt-from-js.md - displayName: AddHostObjectToScript, host objects - - - name: How WinRT types and members are represented in JavaScript - href: webview2/how-to/winrt-js-conversion.md - - name: Using frames href: webview2/concepts/frames.md displayName: Using frames in WebView2 apps, iframe # full title @@ -1346,17 +1326,42 @@ href: webview2/how-to/print.md displayName: Printing from WebView2 apps # full title - # updated h2: Experimental APIs, added a 2nd, new h3: - - name: Understand the different WebView2 SDK versions - href: webview2/concepts/versioning.md - displayName: Understand WebView2 SDK versions # old title - - - name: Distribute your app and the WebView2 Runtime - href: webview2/concepts/distribution.md - - name: Working with local content in WebView2 apps href: webview2/concepts/working-with-local-content.md +# resume here + + - name: Web and native interop + items: + - name: Interop of native-side and web-side code + href: webview2/how-to/communicate-btwn-web-native.md + displayName: JavaScript interop, Embed web content into native applications (JavaScript interop) # old title + + - name: Call web-side code from native-side code + href: webview2/how-to/javascript.md + displayName: ExecuteScriptAsync API, Use JavaScript in WebView for extended scenarios # old title + + - name: Call native-side code from web-side code + href: webview2/how-to/hostobject.md + displayName: AddHostObjectToScript, host objects + + - name: Call native-side WinRT code from web-side code + href: webview2/how-to/winrt-from-js.md + displayName: AddHostObjectToScript, host objects + + - name: How WinRT types and members are represented in JavaScript + href: webview2/how-to/winrt-js-conversion.md + + + # updated h2: Experimental APIs, added a 2nd, new h3: + - name: Understand the different WebView2 SDK versions + href: webview2/concepts/versioning.md + displayName: Understand WebView2 SDK versions # old title + + - name: Distribute your app and the WebView2 Runtime + href: webview2/concepts/distribution.md + + # ----------------------------------------------------------------------------- - name: Test and automation in WebView2 apps items: @@ -1443,16 +1448,23 @@ - name: Develop secure WebView2 apps href: webview2/concepts/security.md - # - name: Customize the UI # not needed? flatten - # items: - # - name: Customize the UI of WebView2 apps - # href: webview2/how-to/customize-ui.md - # displayName: context menu, right-click menu + # - name: Customize the UI in WebView2 apps # not needed? file exists, not revealed in TOC + # items: + # - name: Customize the UI of WebView2 apps + # href: webview2/how-to/customize-ui.md + # displayName: context menu, right-click menu - name: Customize context menus href: webview2/how-to/context-menus.md displayName: right-click menu, Customize context menus in WebView2 # top-of-page title + + + + + + + - name: Use the Chrome DevTools Protocol (CDP) href: webview2/how-to/chromium-devtools-protocol.md displayName: Use the Chrome DevTools Protocol (CDP) in WebView2 apps, chrome developer protocol # top-of-page title & catch a mis-type diff --git a/microsoft-edge/webview2/how-to/customize-ui.md b/microsoft-edge/webview2/how-to/customize-ui.md index 3edade6a91..5585853d9c 100644 --- a/microsoft-edge/webview2/how-to/customize-ui.md +++ b/microsoft-edge/webview2/how-to/customize-ui.md @@ -1,6 +1,6 @@ --- -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 @@ -8,7 +8,7 @@ ms.service: microsoft-edge ms.subservice: webview ms.date: 02/08/2022 --- -# Customizing the UI in WebView2 apps +# Customize the UI in WebView2 apps From c019f7ec8c1c78d326860ff9410c540aef13cd90 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 16:50:18 -0700 Subject: [PATCH 02/25] Apply changes from PR 2725 --- microsoft-edge/toc.yml | 224 ++++++------------ microsoft-edge/webview2/concepts/frames.md | 2 +- .../concepts/overview-features-apis.md | 2 +- .../webview2/concepts/versioning.md | 4 +- .../how-to/communicate-btwn-web-native.md | 4 +- .../webview2/how-to/set-preview-channel.md | 2 +- .../webview2/samples/webview2_sample_uwp.md | 2 +- .../webview2/samples/webview2apissample.md | 2 +- 8 files changed, 88 insertions(+), 154 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 684bc15ab1..172b79a6ad 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -32,45 +32,35 @@ # What's New pages ------------------------------------------------------------ # also add new pages to nav page: /whats-new/whats-new.md # move eleventh oldest into Archive bucket - - name: Microsoft Edge 123 - href: devtools-guide-chromium/whats-new/2024/03/devtools-123.md - displayName: What's New in DevTools (Microsoft Edge 123) - - name: Microsoft Edge 122 href: devtools-guide-chromium/whats-new/2024/02/devtools-122.md - displayName: What's New in DevTools (Microsoft Edge 122) - name: Microsoft Edge 121 href: devtools-guide-chromium/whats-new/2024/01/devtools-121.md - displayName: What's New in DevTools (Microsoft Edge 121) - name: Microsoft Edge 120 href: devtools-guide-chromium/whats-new/2023/12/devtools-120.md - displayName: What's New in DevTools (Microsoft Edge 120) - name: Microsoft Edge 119 href: devtools-guide-chromium/whats-new/2023/11/devtools-119.md - displayName: What's New in DevTools (Microsoft Edge 119) - name: Microsoft Edge 118 href: devtools-guide-chromium/whats-new/2023/10/devtools-118.md - displayName: What's New in DevTools (Microsoft Edge 118) - name: Microsoft Edge 117 href: devtools-guide-chromium/whats-new/2023/09/devtools-117.md - displayName: What's New in DevTools (Microsoft Edge 117) - name: Microsoft Edge 116 href: devtools-guide-chromium/whats-new/2023/08/devtools-116.md - displayName: What's New in DevTools (Microsoft Edge 116) - name: Microsoft Edge 115 href: devtools-guide-chromium/whats-new/2023/07/devtools-115.md - displayName: What's New in DevTools (Microsoft Edge 115) - name: Microsoft Edge 114 href: devtools-guide-chromium/whats-new/2023/06/devtools-114.md - displayName: What's New in DevTools (Microsoft Edge 114) + + - name: Microsoft Edge 113 + href: devtools-guide-chromium/whats-new/2023/05/devtools-113.md # keep 10 items above - name: Archive @@ -78,137 +68,101 @@ - name: What's New in DevTools archive href: devtools-guide-chromium/whats-new/whats-new-archive.md - - name: Microsoft Edge 113 - href: devtools-guide-chromium/whats-new/2023/05/devtools-113.md - displayName: What's New in DevTools (Microsoft Edge 113) - - name: Microsoft Edge 112 href: devtools-guide-chromium/whats-new/2023/04/devtools-112.md - displayName: What's New in DevTools (Microsoft Edge 112) - name: Microsoft Edge 111 href: devtools-guide-chromium/whats-new/2023/03/devtools-111.md - displayName: What's New in DevTools (Microsoft Edge 111) - name: Microsoft Edge 110 href: devtools-guide-chromium/whats-new/2023/02/devtools-110.md - displayName: What's New in DevTools (Microsoft Edge 110) - name: Microsoft Edge 109 href: devtools-guide-chromium/whats-new/2023/01/devtools-109.md - displayName: What's New in DevTools (Microsoft Edge 109) - name: Microsoft Edge 108 href: devtools-guide-chromium/whats-new/2022/12/devtools-108.md - displayName: What's New in DevTools (Microsoft Edge 108) - name: Microsoft Edge 107 href: devtools-guide-chromium/whats-new/2022/10/devtools-107.md - displayName: What's New in DevTools (Microsoft Edge 107) - name: Microsoft Edge 106 href: devtools-guide-chromium/whats-new/2022/09/devtools-106.md - displayName: What's New in DevTools (Microsoft Edge 106) - name: Microsoft Edge 105 href: devtools-guide-chromium/whats-new/2022/09/devtools-105.md - displayName: What's New in DevTools (Microsoft Edge 105) - name: Microsoft Edge 104 href: devtools-guide-chromium/whats-new/2022/08/devtools-104.md - displayName: What's New in DevTools (Microsoft Edge 104) - name: Microsoft Edge 103 href: devtools-guide-chromium/whats-new/2022/06/devtools-103.md - displayName: What's New in DevTools (Microsoft Edge 103) - name: Microsoft Edge 102 href: devtools-guide-chromium/whats-new/2022/05/devtools-102.md - displayName: What's New in DevTools (Microsoft Edge 102) - name: Microsoft Edge 101 href: devtools-guide-chromium/whats-new/2022/04/devtools-101.md - displayName: What's New in DevTools (Microsoft Edge 101) - name: Microsoft Edge 100 href: devtools-guide-chromium/whats-new/2022/03/devtools-100.md - displayName: What's New in DevTools (Microsoft Edge 100) - name: Microsoft Edge 99 href: devtools-guide-chromium/whats-new/2022/03/devtools.md - displayName: What's New in DevTools (Microsoft Edge 99) - name: Microsoft Edge 98 href: devtools-guide-chromium/whats-new/2022/02/devtools.md - displayName: What's New in DevTools (Microsoft Edge 98) - name: Microsoft Edge 97 href: devtools-guide-chromium/whats-new/2022/01/devtools.md - displayName: What's New in DevTools (Microsoft Edge 97) - name: Microsoft Edge 96 href: devtools-guide-chromium/whats-new/2021/11/devtools.md - displayName: What's New in DevTools (Microsoft Edge 96) - name: Microsoft Edge 95 href: devtools-guide-chromium/whats-new/2021/10/devtools.md - displayName: What's New in DevTools (Microsoft Edge 95) - name: Microsoft Edge 94 href: devtools-guide-chromium/whats-new/2021/09/devtools.md - displayName: What's New in DevTools (Microsoft Edge 94) - name: Microsoft Edge 93 href: devtools-guide-chromium/whats-new/2021/07/devtools.md - displayName: What's New in DevTools (Microsoft Edge 93) - name: Microsoft Edge 92 href: devtools-guide-chromium/whats-new/2021/05/devtools.md - displayName: What's New in DevTools (Microsoft Edge 92) - name: Microsoft Edge 91 href: devtools-guide-chromium/whats-new/2021/04/devtools.md - displayName: What's New in DevTools (Microsoft Edge 91) - name: Microsoft Edge 90 href: devtools-guide-chromium/whats-new/2021/02/devtools.md - displayName: What's New in DevTools (Microsoft Edge 90) - name: Microsoft Edge 89 href: devtools-guide-chromium/whats-new/2021/01/devtools.md - displayName: What's New in DevTools (Microsoft Edge 89) - name: Microsoft Edge 88 href: devtools-guide-chromium/whats-new/2020/11/devtools.md - displayName: What's New in DevTools (Microsoft Edge 88) - name: Microsoft Edge 87 href: devtools-guide-chromium/whats-new/2020/10/devtools.md - displayName: What's New in DevTools (Microsoft Edge 87) - name: Microsoft Edge 86 href: devtools-guide-chromium/whats-new/2020/08/devtools.md - displayName: What's New in DevTools (Microsoft Edge 86) - name: Microsoft Edge 85 href: devtools-guide-chromium/whats-new/2020/06/devtools.md - displayName: What's New in DevTools (Microsoft Edge 85) - name: Microsoft Edge 84 href: devtools-guide-chromium/whats-new/2020/05/devtools.md - displayName: What's New in DevTools (Microsoft Edge 84) - name: Microsoft Edge 83 href: devtools-guide-chromium/whats-new/2020/03/devtools.md - displayName: What's New in DevTools (Microsoft Edge 83) - name: Microsoft Edge 81 href: devtools-guide-chromium/whats-new/2020/01/devtools.md - displayName: What's New in DevTools (Microsoft Edge 82) - name: Microsoft Edge 80 href: devtools-guide-chromium/whats-new/2019/12/devtools.md - displayName: What's New in DevTools (Microsoft Edge 80) # Experimental features ------------------------------------------------------------------ - name: Experimental features items: @@ -217,6 +171,10 @@ href: devtools-guide-chromium/experimental-features/index.md displayName: Experimental features, settings + - name: Run commands via keyboard with Command Palette + href: devtools-guide-chromium/experimental-features/edge-command-palette.md + displayName: Experimental features, Edge Command Palette + - name: Share enhanced performance and memory traces href: devtools-guide-chromium/experimental-features/share-traces.md displayName: Experimental features, Enhanced traces, Memory tool, Performance tool @@ -1193,8 +1151,6 @@ - name: Differences between Microsoft Edge and WebView2 href: webview2/concepts/browser-features.md -# ----------------------------------------------------------------------------- -# machine setup - name: Set up your Dev environment for WebView2 href: webview2/how-to/machine-setup.md @@ -1208,7 +1164,7 @@ - name: WinUI 2 (UWP) href: webview2/get-started/winui2.md - displayName: WinUI2_GettingStarted, Get started with WebView2 in WinUI 2 (UWP) apps # repo dir name # top-of-page title + displayName: WinUI2_GettingStarted, Get started with WebView2 in WinUI 2 (UWP) apps # repo dir name # top-of-page title - name: WinUI 3 (Windows App SDK) href: webview2/get-started/winui.md @@ -1243,7 +1199,7 @@ - name: Win32 sample app with Visual Composition href: webview2/samples/webview2samplewincomp.md - displayName: WebView2SampleWinComp # repo dir name + displayName: WebView2SampleWinComp # repo dir name - name: Win32 sample WebView2Browser href: webview2/samples/webview2browser.md @@ -1251,16 +1207,16 @@ - name: WinUI 2 (UWP) sample app href: webview2/samples/webview2_sample_uwp.md - displayName: webview2_sample_uwp # repo dir name + displayName: webview2_sample_uwp # repo dir name # pending, July 26 2022 -# - name: WinUI 3 sample app -# href: webview2/samples/webview2-winui3-sample.md -# displayName: WebView2_WinUI3_Sample # repo dir name +# - name: WinUI 3 sample app +# href: webview2/samples/webview2-winui3-sample.md +# displayName: WebView2_WinUI3_Sample # repo dir name - name: WPF sample app href: webview2/samples/webview2wpfbrowser.md - displayName: WebView2WpfBrowser # repo dir name + displayName: WebView2WpfBrowser # repo dir name - name: WPF sample app with CDP href: webview2/samples/wv2cdpextensionwpfsample.md @@ -1290,7 +1246,6 @@ displayName: WV2DeploymentWiXCustomActionSample # repo dir name # ----------------------------------------------------------------------------- -# top-level entries below Samples - name: "Main classes for WebView2: Environment, Controller, and Core" href: webview2/concepts/environment-controller-core.md @@ -1309,11 +1264,12 @@ - name: Windowed vs. visual hosting of WebView2 href: webview2/concepts/windowed-vs-visual-hosting.md - - name: WebView2 browser flags - href: webview2/concepts/webview-features-flags.md - +# ----------------------------------------------------------------------------- - name: Customization and UI items: + - name: WebView2 browser flags # todo: move entry + href: webview2/concepts/webview-features-flags.md + - name: Custom management of network requests href: webview2/how-to/webresourcerequested.md displayName: WebResourceRequested, WebResourceResponseReceived @@ -1329,38 +1285,63 @@ - name: Working with local content in WebView2 apps href: webview2/concepts/working-with-local-content.md -# resume here + # - name: Customize the UI # not needed? flatten + # items: + # - name: Customize the UI of WebView2 apps + # href: webview2/how-to/customize-ui.md + # displayName: context menu, right-click menu - - name: Web and native interop - items: - - name: Interop of native-side and web-side code - href: webview2/how-to/communicate-btwn-web-native.md - displayName: JavaScript interop, Embed web content into native applications (JavaScript interop) # old title + - name: Customize context menus + href: webview2/how-to/context-menus.md + displayName: right-click menu, Customize context menus in WebView2 # top-of-page title - - name: Call web-side code from native-side code - href: webview2/how-to/javascript.md - displayName: ExecuteScriptAsync API, Use JavaScript in WebView for extended scenarios # old title +# ----------------------------------------------------------------------------- + - name: Web and native interop + items: + - name: Interop of native and web code + href: webview2/how-to/communicate-btwn-web-native.md + displayName: JavaScript interop, Embed web content into native applications (JavaScript interop), Interop of native-side and web-side code # old titles - - name: Call native-side code from web-side code - href: webview2/how-to/hostobject.md - displayName: AddHostObjectToScript, host objects + - name: Call web-side code from native-side code + href: webview2/how-to/javascript.md + displayName: ExecuteScriptAsync API, Use JavaScript in WebView for extended scenarios # old title - - name: Call native-side WinRT code from web-side code - href: webview2/how-to/winrt-from-js.md - displayName: AddHostObjectToScript, host objects + - name: Call native-side code from web-side code + href: webview2/how-to/hostobject.md + displayName: AddHostObjectToScript, host objects - - name: How WinRT types and members are represented in JavaScript - href: webview2/how-to/winrt-js-conversion.md + - name: Call native-side WinRT code from web-side code + href: webview2/how-to/winrt-from-js.md + displayName: AddHostObjectToScript, host objects + - name: How WinRT types and members are represented in JavaScript + href: webview2/how-to/winrt-js-conversion.md - # updated h2: Experimental APIs, added a 2nd, new h3: - - name: Understand the different WebView2 SDK versions - href: webview2/concepts/versioning.md - displayName: Understand WebView2 SDK versions # old title +# ----------------------------------------------------------------------------- + - name: Distribution and SDK versions + items: + - name: Deployment and distribution # new firstchild page + href: webview2/concepts/deployment-distribution.md + displayName: Manage WebView2 applications # old title + + - name: Prerelease and Release SDKs for WebView2 + href: webview2/concepts/versioning.md + displayName: experimental APIs, Understand the different WebView2 SDK versions # old title - - name: Distribute your app and the WebView2 Runtime - href: webview2/concepts/distribution.md + - name: Distribute your app and the WebView2 Runtime + href: webview2/concepts/distribution.md + - name: Enterprise management of WebView2 Runtimes + href: webview2/concepts/enterprise.md + displayName: Manage WebView2 applications # old title + + - name: Distribute an app as a single executable file + href: webview2/how-to/static.md + displayName: Statically link the WebView2 loader library, single-file app # old title + + - name: Publish a UWP WebView2 app to the Microsoft Store + href: webview2/how-to/publish-uwp-app-store.md + displayName: Partner Center, Microsoft Store # ----------------------------------------------------------------------------- - name: Test and automation in WebView2 apps @@ -1368,15 +1349,23 @@ - name: Test upcoming APIs and features href: webview2/how-to/set-preview-channel.md + - name: Development best practices + href: webview2/concepts/developer-guide.md + displayName: Development best practices for WebView2 apps # top-of-page title + + - name: Develop secure WebView2 apps + href: webview2/concepts/security.md + + - name: Use the Chrome DevTools Protocol (CDP) + href: webview2/how-to/chromium-devtools-protocol.md + displayName: Use the Chrome DevTools Protocol (CDP) in WebView2 apps, chrome developer protocol # top-of-page title & catch a mis-type + - name: Use Playwright to automate and test in WebView2 href: webview2/how-to/playwright.md - name: Automate and test WebView2 apps with Microsoft Edge WebDriver href: webview2/how-to/webdriver.md -# ----------------------------------------------------------------------------- - - name: Debug WebView2 apps - items: - name: Debug WebView2 apps href: webview2/how-to/debug.md @@ -1413,7 +1402,6 @@ # ----------------------------------------------------------------------------- - name: Architecture items: - # - name: Architecture of WebView2 # href: webview2/concepts/architecture.md @@ -1438,60 +1426,11 @@ - name: Clear browsing data from the user data folder href: webview2/concepts/clear-browsing-data.md -# ----------------------------------------------------------------------------- - - name: Advanced Topics and Best Practices - items: - - name: Development best practices - href: webview2/concepts/developer-guide.md - displayName: Development best practices for WebView2 apps # top-of-page title - - - name: Develop secure WebView2 apps - href: webview2/concepts/security.md - - # - name: Customize the UI in WebView2 apps # not needed? file exists, not revealed in TOC - # items: - # - name: Customize the UI of WebView2 apps - # href: webview2/how-to/customize-ui.md - # displayName: context menu, right-click menu - - - name: Customize context menus - href: webview2/how-to/context-menus.md - displayName: right-click menu, Customize context menus in WebView2 # top-of-page title - - - - - - - - - - name: Use the Chrome DevTools Protocol (CDP) - href: webview2/how-to/chromium-devtools-protocol.md - displayName: Use the Chrome DevTools Protocol (CDP) in WebView2 apps, chrome developer protocol # top-of-page title & catch a mis-type - - name: Data and privacy href: webview2/concepts/data-privacy.md displayName: Data and privacy in WebView2 # top-of-page title # ----------------------------------------------------------------------------- - - name: Deployment and distribution - items: - - name: Deployment and distribution # new firstchild page - href: webview2/concepts/deployment-distribution.md - displayName: Manage WebView2 applications # old title - - - name: Enterprise management of WebView2 Runtimes - href: webview2/concepts/enterprise.md - displayName: Manage WebView2 applications # old title - - - name: Distribute an app as a single executable file - href: webview2/how-to/static.md - displayName: Statically link the WebView2 loader library, single-file app # old title - - - name: Publish a UWP WebView2 app to the Microsoft Store - href: webview2/how-to/publish-uwp-app-store.md - displayName: Partner Center, Microsoft Store -# ----------------------------------------------------------------- # relnotes - name: Release Notes items: @@ -1507,9 +1446,7 @@ href: webview2/release-notes/archive.md displayName: Archived Release Notes for the WebView2 SDK, what's new, announcements # top-of-page title - -# end of relnotes -# ----------------------------------------------------------------- +# ----------------------------------------------------------------------------- - name: WebView2 Roadmap href: webview2/roadmap.md @@ -1577,11 +1514,8 @@ uid: 'WebView2Script!SharedBufferReceivedEvent:class' - name: WebView uid: 'WebView2Script!WebView:class' - - name: WebViewEventMap - uid: 'WebView2Script!WebViewEventMap:class' - - name: WebViewMessageEvent - uid: 'WebView2Script!WebViewMessageEvent:class' +# ----------------------------------------------------------------------------- - name: WebView2 end-user FAQ href: webview2/concepts/end-user-faq.md diff --git a/microsoft-edge/webview2/concepts/frames.md b/microsoft-edge/webview2/concepts/frames.md index 4170710865..004c6eb06b 100644 --- a/microsoft-edge/webview2/concepts/frames.md +++ b/microsoft-edge/webview2/concepts/frames.md @@ -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:** diff --git a/microsoft-edge/webview2/concepts/overview-features-apis.md b/microsoft-edge/webview2/concepts/overview-features-apis.md index af51d68404..f13e35673b 100644 --- a/microsoft-edge/webview2/concepts/overview-features-apis.md +++ b/microsoft-edge/webview2/concepts/overview-features-apis.md @@ -92,7 +92,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) diff --git a/microsoft-edge/webview2/concepts/versioning.md b/microsoft-edge/webview2/concepts/versioning.md index 65e24555be..45f58d92a5 100644 --- a/microsoft-edge/webview2/concepts/versioning.md +++ b/microsoft-edge/webview2/concepts/versioning.md @@ -1,5 +1,5 @@ --- -title: Understand the different WebView2 SDK versions +title: Prerelease and Release SDKs for WebView2 description: Understand the different WebView2 SDK versions, and version models used for Microsoft Edge WebView2. author: MSEdgeTeam ms.author: msedgedevrel @@ -8,7 +8,7 @@ ms.service: microsoft-edge ms.subservice: webview ms.date: 04/25/2023 --- -# Understand the different WebView2 SDK versions +# Prerelease and Release SDKs for WebView2 The WebView2 SDK is provided as a Prerelease or Release version of the **Microsoft.Web.WebView2** NuGet package. Either use a Prerelease SDK with a preview channel of Microsoft Edge, or use a Release SDK with the WebView2 Runtime. diff --git a/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md b/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md index deb3f6c0ed..a11c3894ff 100644 --- a/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md +++ b/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md @@ -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 @@ -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. diff --git a/microsoft-edge/webview2/how-to/set-preview-channel.md b/microsoft-edge/webview2/how-to/set-preview-channel.md index 5ad5dfdb23..efdaaafe4e 100644 --- a/microsoft-edge/webview2/how-to/set-preview-channel.md +++ b/microsoft-edge/webview2/how-to/set-preview-channel.md @@ -27,7 +27,7 @@ The prerelease SDK works together with a preview channel as follows: * The preview channels of Microsoft Edge contain the Microsoft Edge binaries that are needed to run and render your app, including the implementation of the experimental APIs. -For more information about how SDK versions works in conjunction with the WebView2 Runtime or preview channels of Microsoft Edge, see [Understand the different WebView2 SDK versions](../concepts/versioning.md). +For more information about how SDK versions works in conjunction with the WebView2 Runtime or preview channels of Microsoft Edge, see [Prerelease and Release SDKs for WebView2](../concepts/versioning.md). diff --git a/microsoft-edge/webview2/samples/webview2_sample_uwp.md b/microsoft-edge/webview2/samples/webview2_sample_uwp.md index 4829b2d3cd..f5528d47ae 100644 --- a/microsoft-edge/webview2/samples/webview2_sample_uwp.md +++ b/microsoft-edge/webview2/samples/webview2_sample_uwp.md @@ -117,7 +117,7 @@ Update the project's NuGet packages: 1. Select the **Include prerelease** check box. - A pre-release version of the **Microsoft.UI.Xaml** package is listed, indicating the WinUI 2 SDK. The **Microsoft.UI.Xaml** package includes the WebView2 SDK; **Microsoft.Web.WebView2** is listed in the **Dependencies** section of the **Microsoft.UI.Xaml** package. Updating the **Microsoft.UI.Xaml** package will also cause an update to the compatible WebView2 SDK. + A Prerelease version of the **Microsoft.UI.Xaml** package is listed, indicating the WinUI 2 SDK. The **Microsoft.UI.Xaml** package includes the WebView2 SDK; **Microsoft.Web.WebView2** is listed in the **Dependencies** section of the **Microsoft.UI.Xaml** package. Updating the **Microsoft.UI.Xaml** package will also cause an update to the compatible WebView2 SDK. 1. In the **NuGet Package Manager**, click the **Updates** tab. diff --git a/microsoft-edge/webview2/samples/webview2apissample.md b/microsoft-edge/webview2/samples/webview2apissample.md index 71307dc09b..c43205ee4b 100644 --- a/microsoft-edge/webview2/samples/webview2apissample.md +++ b/microsoft-edge/webview2/samples/webview2apissample.md @@ -176,7 +176,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 pre-release version of the WebView2 SDK installed. Below, you'll update it to the latest pre-release version of the WebView2 SDK, or confirm that the latest SDK is installed. Using a pre-release 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: From 77347df07cf77ec84585841e4189e6bd32b299a9 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 17:15:13 -0700 Subject: [PATCH 03/25] show more full titles in toc --- microsoft-edge/toc.yml | 64 ++++++++----------- .../concepts/process-related-events.md | 6 +- 2 files changed, 28 insertions(+), 42 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 172b79a6ad..a6bf57e6b7 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -827,7 +827,6 @@ displayName: feedback, log issues, enter issues, report issues, reporting issues, support # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: DevTools for Visual Studio Code items: @@ -904,7 +903,6 @@ # /DevTools # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: Microsoft Edge extensions items: - name: Overview of Microsoft Edge extensions @@ -1044,7 +1042,6 @@ displayName: Samples for Microsoft Edge extensions # full title # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: Progressive Web Apps items: @@ -1139,7 +1136,6 @@ href: progressive-web-apps-chromium/demo-pwas.md # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: WebView2 items: - name: Introduction to Microsoft Edge WebView2 @@ -1218,13 +1214,13 @@ href: webview2/samples/webview2wpfbrowser.md displayName: WebView2WpfBrowser # repo dir name - - name: WPF sample app with CDP + - name: WPF sample app with CDP extension href: webview2/samples/wv2cdpextensionwpfsample.md - displayName: WV2CDPExtensionWPFSample, WPF sample app with CDP extension # repo dir name, top-of-page title + displayName: WV2CDPExtensionWPFSample # repo dir name - name: WinForms sample app href: webview2/samples/webview2windowsformsbrowser.md - displayName: WebView2WindowsFormsBrowser, WinForms sample app # repo dir name, top-of-page title + displayName: WebView2WindowsFormsBrowser # repo dir name # ----------------------------------------------------------------------------- # Deployment samples @@ -1253,9 +1249,9 @@ href: webview2/concepts/navigation-events.md displayName: Navigation events for WebView2 apps # top-of-page title - - name: Process-related events + - name: Handle process-related events href: webview2/concepts/process-related-events.md - displayName: Handling process-related events in WebView2 # top-of-page title + displayName: Handle process-related events in WebView2 # top-of-page title - name: Basic authentication href: webview2/concepts/basic-authentication.md @@ -1278,9 +1274,8 @@ href: webview2/concepts/frames.md displayName: Using frames in WebView2 apps, iframe # full title - - name: Printing + - name: Printing from WebView2 apps href: webview2/how-to/print.md - displayName: Printing from WebView2 apps # full title - name: Working with local content in WebView2 apps href: webview2/concepts/working-with-local-content.md @@ -1363,23 +1358,23 @@ - name: Use Playwright to automate and test in WebView2 href: webview2/how-to/playwright.md - - name: Automate and test WebView2 apps with Microsoft Edge WebDriver + - name: Automate and test with Microsoft Edge WebDriver href: webview2/how-to/webdriver.md + displayName: Automate and test WebView2 apps with Microsoft Edge WebDriver # top-of-page title - name: Debug WebView2 apps - href: webview2/how-to/debug.md + items: + - name: Debug WebView2 apps + href: webview2/how-to/debug.md - - name: Microsoft Edge DevTools - href: webview2/how-to/debug-devtools.md - displayName: Debug WebView2 apps with Microsoft Edge DevTools # top-of-page title + - name: Debug WebView2 apps with Microsoft Edge DevTools + href: webview2/how-to/debug-devtools.md - - name: Microsoft Visual Studio Code - href: webview2/how-to/debug-visual-studio-code.md - displayName: Debug WebView2 apps with Visual Studio Code # top-of-page title + - name: Debug WebView2 apps with Visual Studio Code + href: webview2/how-to/debug-visual-studio-code.md - - name: Microsoft Visual Studio - href: webview2/how-to/debug-visual-studio.md - displayName: Debug WebView2 apps with Visual Studio # top-of-page title + - name: Debug WebView2 apps with Visual Studio + href: webview2/how-to/debug-visual-studio.md - name: Remote debugging WebView2 WinUI 2 (UWP) apps items: @@ -1405,13 +1400,11 @@ # - name: Architecture of WebView2 # href: webview2/concepts/architecture.md - - name: Process model + - name: Process model for WebView2 apps href: webview2/concepts/process-model.md - displayName: Process model for WebView2 apps # top-of-page title - - name: Threading model + - name: Threading model for WebView2 apps href: webview2/concepts/threading-model.md - displayName: Threading model for WebView2 apps # top-of-page title # ----------------------------------------------------------------------------- - name: User data and history @@ -1426,25 +1419,22 @@ - name: Clear browsing data from the user data folder href: webview2/concepts/clear-browsing-data.md - - name: Data and privacy + - name: Data and privacy in WebView2 href: webview2/concepts/data-privacy.md - displayName: Data and privacy in WebView2 # top-of-page title # ----------------------------------------------------------------------------- # relnotes - name: Release Notes items: - - name: About # new page + - name: About Release Notes for the WebView2 SDK href: webview2/release-notes/about.md - displayName: About Release Notes for the WebView2 SDK, what's new, announcements # top-of-page title - - name: Release Notes - href: webview2/release-notes/index.md # new location & file name, instead of at wv2 root - displayName: Release Notes for the WebView2 SDK, what's new, announcements # top-of-page title + - name: Release Notes for the WebView2 SDK + href: webview2/release-notes/index.md + displayName: what's new, announcements - - name: Archived Release Notes # new page + - name: Archived Release Notes for the WebView2 SDK href: webview2/release-notes/archive.md - displayName: Archived Release Notes for the WebView2 SDK, what's new, announcements # top-of-page title # ----------------------------------------------------------------------------- - name: WebView2 Roadmap @@ -1525,7 +1515,6 @@ # / WebView2 articles # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: Test and automation items: - name: Test and automation in Microsoft Edge # new firstchild article @@ -1560,7 +1549,6 @@ href: test-and-automation/webhint.md # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: Development tips for Microsoft Edge items: - name: Development tips for Microsoft Edge @@ -1597,7 +1585,6 @@ displayName: JSON viewer, view JSON # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: Microsoft Edge IDE integration items: - name: Microsoft Edge IDE integration @@ -1617,7 +1604,6 @@ href: visual-studio/index.md # ============================================================================= -# if top-of-page title is longer, add it to displayName comma-delimited list of lookup keywords - name: Accessibility in Microsoft Edge items: - name: Accessibility in Microsoft Edge diff --git a/microsoft-edge/webview2/concepts/process-related-events.md b/microsoft-edge/webview2/concepts/process-related-events.md index 8ad157e1fd..5091c027bd 100644 --- a/microsoft-edge/webview2/concepts/process-related-events.md +++ b/microsoft-edge/webview2/concepts/process-related-events.md @@ -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 @@ -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). From 0028215d8325498227135175c79692f5fe84edd5 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 17:23:52 -0700 Subject: [PATCH 04/25] move deploy samples to deploy toc bucket --- microsoft-edge/toc.yml | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index a6bf57e6b7..75d3dc1f86 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1222,25 +1222,6 @@ href: webview2/samples/webview2windowsformsbrowser.md displayName: WebView2WindowsFormsBrowser # repo dir name -# ----------------------------------------------------------------------------- -# Deployment samples - - name: Deployment samples - items: - - name: Deployment samples - href: webview2/samples/deployment-samples.md - - - name: WebView2 Deployment Visual Studio installer - href: webview2/samples/wv2deploymentvsinstallersample.md - displayName: WV2DeploymentVSInstallerSample # repo dir name - - - name: WiX Burn Bundle to deploy the WebView2 Runtime - href: webview2/samples/wv2deploymentwixburnbundlesample.md - displayName: WV2DeploymentWiXBurnBundleSample # repo dir name - - - name: WiX Custom Action to deploy the WebView2 Runtime - href: webview2/samples/wv2deploymentwixcustomactionsample.md - displayName: WV2DeploymentWiXCustomActionSample # repo dir name - # ----------------------------------------------------------------------------- - name: "Main classes for WebView2: Environment, Controller, and Core" href: webview2/concepts/environment-controller-core.md @@ -1319,6 +1300,23 @@ href: webview2/concepts/deployment-distribution.md displayName: Manage WebView2 applications # old title + - name: Deployment samples + items: + - name: Deployment samples + href: webview2/samples/deployment-samples.md + + - name: WebView2 Deployment Visual Studio installer + href: webview2/samples/wv2deploymentvsinstallersample.md + displayName: WV2DeploymentVSInstallerSample # repo dir name + + - name: WiX Burn Bundle to deploy the WebView2 Runtime + href: webview2/samples/wv2deploymentwixburnbundlesample.md + displayName: WV2DeploymentWiXBurnBundleSample # repo dir name + + - name: WiX Custom Action to deploy the WebView2 Runtime + href: webview2/samples/wv2deploymentwixcustomactionsample.md + displayName: WV2DeploymentWiXCustomActionSample # repo dir name + - name: Prerelease and Release SDKs for WebView2 href: webview2/concepts/versioning.md displayName: experimental APIs, Understand the different WebView2 SDK versions # old title From f2920629cf3b68889efaeaa4df28f39293cbed21 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 17:39:39 -0700 Subject: [PATCH 05/25] consistent article titles for samples --- microsoft-edge/developer/index.yml | 2 +- microsoft-edge/index.yml | 2 +- microsoft-edge/toc.yml | 4 ++-- microsoft-edge/webview2/code-samples-links.md | 5 +++-- microsoft-edge/webview2/concepts/navigation-events.md | 2 +- microsoft-edge/webview2/get-started/get-started.md | 2 +- microsoft-edge/webview2/get-started/win32.md | 2 +- microsoft-edge/webview2/get-started/winui.md | 2 +- microsoft-edge/webview2/get-started/winui2.md | 2 +- microsoft-edge/webview2/get-started/wpf.md | 2 +- .../webview2/how-to/communicate-btwn-web-native.md | 2 +- microsoft-edge/webview2/samples/deployment-samples.md | 5 +++-- 12 files changed, 17 insertions(+), 15 deletions(-) diff --git a/microsoft-edge/developer/index.yml b/microsoft-edge/developer/index.yml index aabea78291..54f98e5422 100644 --- a/microsoft-edge/developer/index.yml +++ b/microsoft-edge/developer/index.yml @@ -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: diff --git a/microsoft-edge/index.yml b/microsoft-edge/index.yml index 05f75cf2a5..3e884ed901 100644 --- a/microsoft-edge/index.yml +++ b/microsoft-edge/index.yml @@ -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 diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 75d3dc1f86..ba9db13349 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1186,7 +1186,7 @@ # Sample apps - name: Sample apps items: - - name: Sample apps + - name: WebView2 sample apps href: webview2/code-samples-links.md - name: Win32 sample app @@ -1302,7 +1302,7 @@ - name: Deployment samples items: - - name: Deployment samples + - name: WebView2 deployment samples href: webview2/samples/deployment-samples.md - name: WebView2 Deployment Visual Studio installer diff --git a/microsoft-edge/webview2/code-samples-links.md b/microsoft-edge/webview2/code-samples-links.md index d3aab2a35f..e31241ae16 100644 --- a/microsoft-edge/webview2/code-samples-links.md +++ b/microsoft-edge/webview2/code-samples-links.md @@ -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 @@ -8,7 +8,7 @@ ms.service: microsoft-edge ms.subservice: webview ms.date: 08/29/2022 --- -# Sample apps +# WebView2 sample apps @@ -52,3 +52,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) diff --git a/microsoft-edge/webview2/concepts/navigation-events.md b/microsoft-edge/webview2/concepts/navigation-events.md index 9f80e46ef3..54fe0a0f7e 100644 --- a/microsoft-edge/webview2/concepts/navigation-events.md +++ b/microsoft-edge/webview2/concepts/navigation-events.md @@ -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 14 - Navigation events](../get-started/win32.md#step-14---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. diff --git a/microsoft-edge/webview2/get-started/get-started.md b/microsoft-edge/webview2/get-started/get-started.md index 719d96a3a9..f752f0b606 100644 --- a/microsoft-edge/webview2/get-started/get-started.md +++ b/microsoft-edge/webview2/get-started/get-started.md @@ -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. diff --git a/microsoft-edge/webview2/get-started/win32.md b/microsoft-edge/webview2/get-started/win32.md index 5ebbbe9898..e9ba4ed834 100644 --- a/microsoft-edge/webview2/get-started/win32.md +++ b/microsoft-edge/webview2/get-started/win32.md @@ -581,6 +581,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. diff --git a/microsoft-edge/webview2/get-started/winui.md b/microsoft-edge/webview2/get-started/winui.md index 12723b54c2..a04d08eddb 100644 --- a/microsoft-edge/webview2/get-started/winui.md +++ b/microsoft-edge/webview2/get-started/winui.md @@ -459,7 +459,7 @@ The following classes aren't accessible in WinUI 3: * [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: diff --git a/microsoft-edge/webview2/get-started/winui2.md b/microsoft-edge/webview2/get-started/winui2.md index 11022a37ab..b31c67d0a1 100644 --- a/microsoft-edge/webview2/get-started/winui2.md +++ b/microsoft-edge/webview2/get-started/winui2.md @@ -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: diff --git a/microsoft-edge/webview2/get-started/wpf.md b/microsoft-edge/webview2/get-started/wpf.md index b11258d40e..a69debb662 100644 --- a/microsoft-edge/webview2/get-started/wpf.md +++ b/microsoft-edge/webview2/get-started/wpf.md @@ -571,7 +571,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: diff --git a/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md b/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md index a11c3894ff..67c212dddb 100644 --- a/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md +++ b/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md @@ -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). diff --git a/microsoft-edge/webview2/samples/deployment-samples.md b/microsoft-edge/webview2/samples/deployment-samples.md index 46917c2043..94b5c9b43e 100644 --- a/microsoft-edge/webview2/samples/deployment-samples.md +++ b/microsoft-edge/webview2/samples/deployment-samples.md @@ -1,5 +1,5 @@ --- -title: Deployment samples +title: WebView2 deployment samples description: Deployment samples for WebView2. author: MSEdgeTeam ms.author: msedgedevrel @@ -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. @@ -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) From c9436a990657251f4df874e0b248a0c0f5d01dca Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 18:04:15 -0700 Subject: [PATCH 06/25] promote "Web and native interop" in TOC --- microsoft-edge/toc.yml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index ba9db13349..9a0a87de4a 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1272,26 +1272,26 @@ displayName: right-click menu, Customize context menus in WebView2 # top-of-page title # ----------------------------------------------------------------------------- - - name: Web and native interop - items: - - name: Interop of native and web code - href: webview2/how-to/communicate-btwn-web-native.md - displayName: JavaScript interop, Embed web content into native applications (JavaScript interop), Interop of native-side and web-side code # old titles + - name: Web and native interop + items: + - name: Interop of native and web code + href: webview2/how-to/communicate-btwn-web-native.md + displayName: JavaScript interop, Embed web content into native applications (JavaScript interop), Interop of native-side and web-side code # old titles - - name: Call web-side code from native-side code - href: webview2/how-to/javascript.md - displayName: ExecuteScriptAsync API, Use JavaScript in WebView for extended scenarios # old title + - name: Call web-side code from native-side code + href: webview2/how-to/javascript.md + displayName: ExecuteScriptAsync API, Use JavaScript in WebView for extended scenarios # old title - - name: Call native-side code from web-side code - href: webview2/how-to/hostobject.md - displayName: AddHostObjectToScript, host objects + - name: Call native-side code from web-side code + href: webview2/how-to/hostobject.md + displayName: AddHostObjectToScript, host objects - - name: Call native-side WinRT code from web-side code - href: webview2/how-to/winrt-from-js.md - displayName: AddHostObjectToScript, host objects + - name: Call native-side WinRT code from web-side code + href: webview2/how-to/winrt-from-js.md + displayName: AddHostObjectToScript, host objects - - name: How WinRT types and members are represented in JavaScript - href: webview2/how-to/winrt-js-conversion.md + - name: How WinRT types and members are represented in JavaScript + href: webview2/how-to/winrt-js-conversion.md # ----------------------------------------------------------------------------- - name: Distribution and SDK versions From 9da2e53dea10ce0448803f553f9ceb69ceb3a8b5 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 18:11:25 -0700 Subject: [PATCH 07/25] Working with --> Use --- microsoft-edge/toc.yml | 2 +- microsoft-edge/webview2/concepts/overview-features-apis.md | 2 +- .../webview2/concepts/working-with-local-content.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 9a0a87de4a..9edd39bfe9 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1258,7 +1258,7 @@ - name: Printing from WebView2 apps href: webview2/how-to/print.md - - name: Working with local content in WebView2 apps + - name: Use local content in WebView2 apps href: webview2/concepts/working-with-local-content.md # - name: Customize the UI # not needed? flatten diff --git a/microsoft-edge/webview2/concepts/overview-features-apis.md b/microsoft-edge/webview2/concepts/overview-features-apis.md index f13e35673b..966d4fe833 100644 --- a/microsoft-edge/webview2/concepts/overview-features-apis.md +++ b/microsoft-edge/webview2/concepts/overview-features-apis.md @@ -1514,7 +1514,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) diff --git a/microsoft-edge/webview2/concepts/working-with-local-content.md b/microsoft-edge/webview2/concepts/working-with-local-content.md index ebca7871e3..1a0a46fa81 100644 --- a/microsoft-edge/webview2/concepts/working-with-local-content.md +++ b/microsoft-edge/webview2/concepts/working-with-local-content.md @@ -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 @@ -8,7 +8,7 @@ ms.service: microsoft-edge ms.subservice: webview ms.date: 01/10/2023 --- -# 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. From fb98d26310a1614cee336e28d3abafb201e2b486 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 19:09:18 -0700 Subject: [PATCH 08/25] catch up What's New's w/ "main" --- microsoft-edge/toc.yml | 54 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 50 insertions(+), 4 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 9edd39bfe9..65edf70f5e 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -32,35 +32,49 @@ # What's New pages ------------------------------------------------------------ # also add new pages to nav page: /whats-new/whats-new.md # move eleventh oldest into Archive bucket + - name: Microsoft Edge 123 + href: devtools-guide-chromium/whats-new/2024/03/devtools-123.md + displayName: What's New in DevTools (Microsoft Edge 123) # top-of-page title + - name: Microsoft Edge 122 href: devtools-guide-chromium/whats-new/2024/02/devtools-122.md + displayName: What's New in DevTools (Microsoft Edge 122) # top-of-page title - name: Microsoft Edge 121 href: devtools-guide-chromium/whats-new/2024/01/devtools-121.md + displayName: What's New in DevTools (Microsoft Edge 121) # top-of-page title - name: Microsoft Edge 120 href: devtools-guide-chromium/whats-new/2023/12/devtools-120.md + displayName: What's New in DevTools (Microsoft Edge 120) # top-of-page title - name: Microsoft Edge 119 href: devtools-guide-chromium/whats-new/2023/11/devtools-119.md + displayName: What's New in DevTools (Microsoft Edge 119) # top-of-page title - name: Microsoft Edge 118 href: devtools-guide-chromium/whats-new/2023/10/devtools-118.md + displayName: What's New in DevTools (Microsoft Edge 118) # top-of-page title - name: Microsoft Edge 117 href: devtools-guide-chromium/whats-new/2023/09/devtools-117.md + displayName: What's New in DevTools (Microsoft Edge 117) # top-of-page title - name: Microsoft Edge 116 href: devtools-guide-chromium/whats-new/2023/08/devtools-116.md + displayName: What's New in DevTools (Microsoft Edge 116) # top-of-page title - name: Microsoft Edge 115 href: devtools-guide-chromium/whats-new/2023/07/devtools-115.md + displayName: What's New in DevTools (Microsoft Edge 115) # top-of-page title - name: Microsoft Edge 114 href: devtools-guide-chromium/whats-new/2023/06/devtools-114.md + displayName: What's New in DevTools (Microsoft Edge 114) # top-of-page title - name: Microsoft Edge 113 href: devtools-guide-chromium/whats-new/2023/05/devtools-113.md + displayName: What's New in DevTools (Microsoft Edge 113) # top-of-page title # keep 10 items above - name: Archive @@ -70,99 +84,135 @@ - name: Microsoft Edge 112 href: devtools-guide-chromium/whats-new/2023/04/devtools-112.md + displayName: What's New in DevTools (Microsoft Edge 112) # top-of-page title - name: Microsoft Edge 111 href: devtools-guide-chromium/whats-new/2023/03/devtools-111.md + displayName: What's New in DevTools (Microsoft Edge 111) # top-of-page title - name: Microsoft Edge 110 href: devtools-guide-chromium/whats-new/2023/02/devtools-110.md + displayName: What's New in DevTools (Microsoft Edge 110) # top-of-page title - name: Microsoft Edge 109 href: devtools-guide-chromium/whats-new/2023/01/devtools-109.md + displayName: What's New in DevTools (Microsoft Edge 109) # top-of-page title - name: Microsoft Edge 108 href: devtools-guide-chromium/whats-new/2022/12/devtools-108.md + displayName: What's New in DevTools (Microsoft Edge 108) # top-of-page title - name: Microsoft Edge 107 href: devtools-guide-chromium/whats-new/2022/10/devtools-107.md + displayName: What's New in DevTools (Microsoft Edge 107) # top-of-page title - name: Microsoft Edge 106 href: devtools-guide-chromium/whats-new/2022/09/devtools-106.md + displayName: What's New in DevTools (Microsoft Edge 106) # top-of-page title - name: Microsoft Edge 105 href: devtools-guide-chromium/whats-new/2022/09/devtools-105.md + displayName: What's New in DevTools (Microsoft Edge 105) # top-of-page title - name: Microsoft Edge 104 href: devtools-guide-chromium/whats-new/2022/08/devtools-104.md + displayName: What's New in DevTools (Microsoft Edge 104) # top-of-page title - name: Microsoft Edge 103 href: devtools-guide-chromium/whats-new/2022/06/devtools-103.md + displayName: What's New in DevTools (Microsoft Edge 103) # top-of-page title - name: Microsoft Edge 102 href: devtools-guide-chromium/whats-new/2022/05/devtools-102.md + displayName: What's New in DevTools (Microsoft Edge 102) # top-of-page title - name: Microsoft Edge 101 href: devtools-guide-chromium/whats-new/2022/04/devtools-101.md + displayName: What's New in DevTools (Microsoft Edge 101) # top-of-page title - name: Microsoft Edge 100 href: devtools-guide-chromium/whats-new/2022/03/devtools-100.md + displayName: What's New in DevTools (Microsoft Edge 100) # top-of-page title - name: Microsoft Edge 99 href: devtools-guide-chromium/whats-new/2022/03/devtools.md + displayName: What's New in DevTools (Microsoft Edge 99) # top-of-page title - name: Microsoft Edge 98 href: devtools-guide-chromium/whats-new/2022/02/devtools.md + displayName: What's New in DevTools (Microsoft Edge 98) # top-of-page title - name: Microsoft Edge 97 href: devtools-guide-chromium/whats-new/2022/01/devtools.md + displayName: What's New in DevTools (Microsoft Edge 97) # top-of-page title - name: Microsoft Edge 96 href: devtools-guide-chromium/whats-new/2021/11/devtools.md + displayName: What's New in DevTools (Microsoft Edge 96) # top-of-page title - name: Microsoft Edge 95 href: devtools-guide-chromium/whats-new/2021/10/devtools.md + displayName: What's New in DevTools (Microsoft Edge 95) # top-of-page title - name: Microsoft Edge 94 href: devtools-guide-chromium/whats-new/2021/09/devtools.md + displayName: What's New in DevTools (Microsoft Edge 94) # top-of-page title - name: Microsoft Edge 93 href: devtools-guide-chromium/whats-new/2021/07/devtools.md + displayName: What's New in DevTools (Microsoft Edge 93) # top-of-page title - name: Microsoft Edge 92 href: devtools-guide-chromium/whats-new/2021/05/devtools.md + displayName: What's New in DevTools (Microsoft Edge 92) # top-of-page title - name: Microsoft Edge 91 href: devtools-guide-chromium/whats-new/2021/04/devtools.md + displayName: What's New in DevTools (Microsoft Edge 91) # top-of-page title - name: Microsoft Edge 90 href: devtools-guide-chromium/whats-new/2021/02/devtools.md + displayName: What's New in DevTools (Microsoft Edge 90) # top-of-page title - name: Microsoft Edge 89 href: devtools-guide-chromium/whats-new/2021/01/devtools.md + displayName: What's New in DevTools (Microsoft Edge 89) # top-of-page title - name: Microsoft Edge 88 href: devtools-guide-chromium/whats-new/2020/11/devtools.md + displayName: What's New in DevTools (Microsoft Edge 88) # top-of-page title - name: Microsoft Edge 87 href: devtools-guide-chromium/whats-new/2020/10/devtools.md + displayName: What's New in DevTools (Microsoft Edge 87) # top-of-page title - name: Microsoft Edge 86 href: devtools-guide-chromium/whats-new/2020/08/devtools.md + displayName: What's New in DevTools (Microsoft Edge 86) # top-of-page title - name: Microsoft Edge 85 href: devtools-guide-chromium/whats-new/2020/06/devtools.md + displayName: What's New in DevTools (Microsoft Edge 85) # top-of-page title - name: Microsoft Edge 84 href: devtools-guide-chromium/whats-new/2020/05/devtools.md + displayName: What's New in DevTools (Microsoft Edge 84) # top-of-page title - name: Microsoft Edge 83 href: devtools-guide-chromium/whats-new/2020/03/devtools.md + displayName: What's New in DevTools (Microsoft Edge 83) # top-of-page title + +# - name: Microsoft Edge 82 +# href: devtools-guide-chromium/whats-new/2020/02/devtools.md # no such file +# displayName: What's New in DevTools (Microsoft Edge 82) # top-of-page title - name: Microsoft Edge 81 href: devtools-guide-chromium/whats-new/2020/01/devtools.md + displayName: What's New in DevTools (Microsoft Edge 81) # top-of-page title - name: Microsoft Edge 80 href: devtools-guide-chromium/whats-new/2019/12/devtools.md + displayName: What's New in DevTools (Microsoft Edge 80) # top-of-page title # Experimental features ------------------------------------------------------------------ - name: Experimental features items: @@ -171,10 +221,6 @@ href: devtools-guide-chromium/experimental-features/index.md displayName: Experimental features, settings - - name: Run commands via keyboard with Command Palette - href: devtools-guide-chromium/experimental-features/edge-command-palette.md - displayName: Experimental features, Edge Command Palette - - name: Share enhanced performance and memory traces href: devtools-guide-chromium/experimental-features/share-traces.md displayName: Experimental features, Enhanced traces, Memory tool, Performance tool From d3771ce0a8b38456906dc93b2046d2b9ba72c74f Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 10 Apr 2024 19:10:57 -0700 Subject: [PATCH 09/25] move What's New 113 to Archive, like in "main" --- microsoft-edge/toc.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 65edf70f5e..958ba13b60 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -72,16 +72,16 @@ href: devtools-guide-chromium/whats-new/2023/06/devtools-114.md displayName: What's New in DevTools (Microsoft Edge 114) # top-of-page title - - name: Microsoft Edge 113 - href: devtools-guide-chromium/whats-new/2023/05/devtools-113.md - displayName: What's New in DevTools (Microsoft Edge 113) # top-of-page title - # keep 10 items above - name: Archive items: - name: What's New in DevTools archive href: devtools-guide-chromium/whats-new/whats-new-archive.md + - name: Microsoft Edge 113 + href: devtools-guide-chromium/whats-new/2023/05/devtools-113.md + displayName: What's New in DevTools (Microsoft Edge 113) # top-of-page title + - name: Microsoft Edge 112 href: devtools-guide-chromium/whats-new/2023/04/devtools-112.md displayName: What's New in DevTools (Microsoft Edge 112) # top-of-page title From 43738e46bbf7318efe2f3446d564f9abcbd4c8ce Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 16 Oct 2024 07:57:58 -0700 Subject: [PATCH 10/25] Samples before GetStarts --- microsoft-edge/toc.yml | 64 +++++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 0bc921ad2e..d3b1e29f3a 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1255,38 +1255,6 @@ - name: Set up your Dev environment for WebView2 href: webview2/how-to/machine-setup.md -# ----------------------------------------------------------------------------- -# Getting Started tutorials - - name: Getting Started tutorials - items: - - name: Getting Started tutorials - href: webview2/get-started/get-started.md - displayName: GettingStartedGuides # repo dir name - - - name: WinUI 2 (UWP) - href: webview2/get-started/winui2.md - displayName: WinUI2_GettingStarted, Get started with WebView2 in WinUI 2 (UWP) apps # repo dir name # top-of-page title - - - name: WinUI 3 (Windows App SDK) - href: webview2/get-started/winui.md - displayName: WinUI3_GettingStarted, Get started with WebView2 in WinUI 3 (Windows App SDK) apps # repo dir name # top-of-page title - - - name: WPF - href: webview2/get-started/wpf.md - displayName: WPF_GettingStarted, Get started with WebView2 in WPF apps # repo dir name # top-of-page title - - - name: WinForms - href: webview2/get-started/winforms.md - displayName: WinForms_GettingStarted, Get started with WebView2 in WinForms apps # repo dir name # top-of-page title - - - name: Win32 - href: webview2/get-started/win32.md - displayName: Win32_GettingStarted, Get started with WebView2 in Win32 apps # repo dir name # top-of-page title - - - name: HoloLens 2 - href: webview2/get-started/hololens2.md - displayName: HoloLens2_GettingStarted, Get started with WebView2 in HoloLens 2 Unity apps (Preview) # repo dir name # top-of-page title - # ----------------------------------------------------------------------------- # Sample apps - name: Sample apps @@ -1327,6 +1295,38 @@ href: webview2/samples/webview2windowsformsbrowser.md displayName: WebView2WindowsFormsBrowser # repo dir name +# ----------------------------------------------------------------------------- +# Getting Started tutorials + - name: Getting Started tutorials + items: + - name: Getting Started tutorials + href: webview2/get-started/get-started.md + displayName: GettingStartedGuides # repo dir name + + - name: WinUI 2 (UWP) + href: webview2/get-started/winui2.md + displayName: WinUI2_GettingStarted, Get started with WebView2 in WinUI 2 (UWP) apps # repo dir name # top-of-page title + + - name: WinUI 3 (Windows App SDK) + href: webview2/get-started/winui.md + displayName: WinUI3_GettingStarted, Get started with WebView2 in WinUI 3 (Windows App SDK) apps # repo dir name # top-of-page title + + - name: WPF + href: webview2/get-started/wpf.md + displayName: WPF_GettingStarted, Get started with WebView2 in WPF apps # repo dir name # top-of-page title + + - name: WinForms + href: webview2/get-started/winforms.md + displayName: WinForms_GettingStarted, Get started with WebView2 in WinForms apps # repo dir name # top-of-page title + + - name: Win32 + href: webview2/get-started/win32.md + displayName: Win32_GettingStarted, Get started with WebView2 in Win32 apps # repo dir name # top-of-page title + + - name: HoloLens 2 + href: webview2/get-started/hololens2.md + displayName: HoloLens2_GettingStarted, Get started with WebView2 in HoloLens 2 Unity apps (Preview) # repo dir name # top-of-page title + # ----------------------------------------------------------------------------- - name: "Main classes for WebView2: Environment, Controller, and Core" href: webview2/concepts/environment-controller-core.md From 8c279fb9c5fb643a803eea714c7828d9dca2b79a Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Mon, 28 Oct 2024 12:20:29 -0700 Subject: [PATCH 11/25] sequence of samples to install/run --- microsoft-edge/webview2/index.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/microsoft-edge/webview2/index.md b/microsoft-edge/webview2/index.md index 6fb7ee9bb2..c85613a028 100644 --- a/microsoft-edge/webview2/index.md +++ b/microsoft-edge/webview2/index.md @@ -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 @@ -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 @@ -108,11 +106,25 @@ 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). +1. Read the documentation and develop your app. + +Some samples might require updating an SDK, as explained in the article for each sample. + + ## 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: From 99e945e983c72e5026def9413bc5b9a0f74bafb0 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Mon, 28 Oct 2024 12:24:17 -0700 Subject: [PATCH 12/25] adjust/trim list --- microsoft-edge/webview2/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/microsoft-edge/webview2/index.md b/microsoft-edge/webview2/index.md index c85613a028..d06e5d740e 100644 --- a/microsoft-edge/webview2/index.md +++ b/microsoft-edge/webview2/index.md @@ -116,10 +116,11 @@ To start learning WebView2, use the following recommended sequence: 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). -1. Read the documentation and develop your app. Some samples might require updating an SDK, as explained in the article for each sample. +After your environment is set up and the most relevant samples are running, you can read the other documentation and develop your app. + ## See also From f0890c4a2740f108f3bb9faeca9cb662b70e3c57 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 30 Oct 2024 08:26:52 -0700 Subject: [PATCH 13/25] can read --- microsoft-edge/webview2/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/microsoft-edge/webview2/index.md b/microsoft-edge/webview2/index.md index d06e5d740e..5ee9428dec 100644 --- a/microsoft-edge/webview2/index.md +++ b/microsoft-edge/webview2/index.md @@ -119,7 +119,7 @@ To start learning WebView2, use the following recommended sequence: Some samples might require updating an SDK, as explained in the article for each sample. -After your environment is set up and the most relevant samples are running, you can read the other documentation and develop your app. +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). From 5d72723237f0785e1a66a0070932e25a54a4a244 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Thu, 7 Nov 2024 08:10:41 -0800 Subject: [PATCH 14/25] group sample w/ getstart per plat --- microsoft-edge/toc.yml | 173 +++++++++++++++++++++++------------------ 1 file changed, 96 insertions(+), 77 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 18f7f6a772..7711cb0040 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -13,22 +13,17 @@ displayName: DevTools # ============================================================================= -# DevTools Overview articles: - +# DevTools # Overview of DevTools -------------------------------------------------------- - name: Overview of DevTools href: devtools-guide-chromium/overview.md displayName: DevTools - # What's New ------------------------------------------------------------------ - name: What's New items: - -# What's New firstchild article - name: What's New in Microsoft Edge DevTools href: devtools-guide-chromium/whats-new/whats-new.md displayName: release notes, announcements - # What's New pages ------------------------------------------------------------ # move eleventh oldest into Archive bucket - name: Microsoft Edge 130 @@ -723,8 +718,7 @@ - name: Welcome tool href: devtools-guide-chromium/welcome/welcome-tool.md displayName: Welcome tool -# /Tools bucket -# LOWER NON-TOOL NODES ======================================================== +# /Tools # Command Menu ---------------------------------------------------------------- - name: Command Menu and keyboard shortcuts items: @@ -736,7 +730,6 @@ href: devtools-guide-chromium/shortcuts/index.md displayName: Keyboard shortcuts # Settings pages and Customize menu ------------------------------------------- -# Experimental features could go here - name: Settings and customization UI items: - name: Customize DevTools # orig: "Customization" @@ -751,11 +744,11 @@ href: devtools-guide-chromium/customize/placement.md displayName: settings - - name: Change DevTools language settings # added article + - name: Change DevTools language settings href: devtools-guide-chromium/customize/localization.md displayName: Settings, Preferences - - name: Customize keyboard shortcuts # added article + - name: Customize keyboard shortcuts href: devtools-guide-chromium/customize/shortcuts.md displayName: Settings, Shortcuts @@ -986,6 +979,7 @@ # /DevTools # ============================================================================= +# Extensions - name: Microsoft Edge extensions items: - name: Microsoft Edge extensions documentation @@ -1157,10 +1151,10 @@ - name: Contact the Microsoft Edge extensions team href: extensions-chromium/publish/contact-extensions-team.md displayName: feedback, log issues, enter issues, report issues, reporting issues - # /Extensions # ============================================================================= +# PWA - name: Progressive Web Apps items: - name: Overview of Progressive Web Apps (PWAs) @@ -1242,8 +1236,10 @@ - name: Progressive Web App demos href: progressive-web-apps-chromium/demo-pwas.md +# /PWA # ============================================================================= +# WebView2 - name: WebView2 items: - name: Introduction to Microsoft Edge WebView2 @@ -1259,11 +1255,11 @@ href: webview2/how-to/machine-setup.md # ----------------------------------------------------------------------------- -# Sample apps - - name: Sample apps +# Platforms: Intro, Samples, GetStarts + - name: Win32 items: - - name: WebView2 sample apps - href: webview2/code-samples-links.md +# - name: WebView2 in Win32 apps +# href: webview2/platforms/win32.md - name: Win32 sample app href: webview2/samples/webview2apissample.md @@ -1277,14 +1273,41 @@ href: webview2/samples/webview2browser.md displayName: WebView2Browser # repo dir name + - name: Get started with WebView2 in Win32 apps + href: webview2/get-started/win32.md + displayName: Win32_GettingStarted # repo dir name + + - name: WinUI 2 (UWP) + items: +# - name: WebView2 in WinUI 2 (UWP) apps +# href: webview2/platforms/winui2-uwp.md + - name: WinUI 2 (UWP) sample app href: webview2/samples/webview2_sample_uwp.md displayName: webview2_sample_uwp # repo dir name + - name: Get started with WebView2 in WinUI 2 (UWP) apps + href: webview2/get-started/winui2.md + displayName: WinUI2_GettingStarted # repo dir name + + - name: WinUI 3 (Windows App SDK) + items: +# - name: WebView2 in WinUI 3 (Windows App SDK) apps +# href: webview2/platforms/winui3-windows-app-sdk.md + - name: WinUI 3 (Windows App SDK) sample app href: webview2/samples/webview2-winui3-sample.md displayName: WebView2_WinUI3_Sample # repo dir name + - name: Get started with WebView2 in WinUI 3 (Windows App SDK) apps + href: webview2/get-started/winui.md + displayName: WinUI3_GettingStarted # repo dir name + + - name: WebView2 in WPF apps + items: +# - name: WebView2 apps on Win32 +# href: webview2/platforms/wpf.md + - name: WPF sample app href: webview2/samples/webview2wpfbrowser.md displayName: WebView2WpfBrowser # repo dir name @@ -1293,57 +1316,51 @@ href: webview2/samples/wv2cdpextensionwpfsample.md displayName: WV2CDPExtensionWPFSample # repo dir name - - name: WinForms sample app - href: webview2/samples/webview2windowsformsbrowser.md - displayName: WebView2WindowsFormsBrowser # repo dir name + - name: Get started with WebView2 in WPF apps + href: webview2/get-started/wpf.md + displayName: WPF_GettingStarted # repo dir name -# ----------------------------------------------------------------------------- -# Getting Started tutorials - - name: Getting Started tutorials + - name: WinForms items: - - name: Getting Started tutorials - href: webview2/get-started/get-started.md - displayName: GettingStartedGuides # repo dir name - - - name: WinUI 2 (UWP) - href: webview2/get-started/winui2.md - displayName: WinUI2_GettingStarted, Get started with WebView2 in WinUI 2 (UWP) apps # repo dir name # top-of-page title - - - name: WinUI 3 (Windows App SDK) - href: webview2/get-started/winui.md - displayName: WinUI3_GettingStarted, Get started with WebView2 in WinUI 3 (Windows App SDK) apps # repo dir name # top-of-page title +# - name: WebView2 in WinForms apps +# href: webview2/platforms/winforms.md - - name: WPF - href: webview2/get-started/wpf.md - displayName: WPF_GettingStarted, Get started with WebView2 in WPF apps # repo dir name # top-of-page title + - name: WinForms sample app + href: webview2/samples/webview2windowsformsbrowser.md + displayName: WebView2WindowsFormsBrowser # repo dir name - - name: WinForms + - name: Get started with WebView2 in WinForms apps href: webview2/get-started/winforms.md - displayName: WinForms_GettingStarted, Get started with WebView2 in WinForms apps # repo dir name # top-of-page title + displayName: WinForms_GettingStarted # repo dir name - - name: Win32 - href: webview2/get-started/win32.md - displayName: Win32_GettingStarted, Get started with WebView2 in Win32 apps # repo dir name # top-of-page title + - name: HoloLens 2 Unity + items: +# - name: WebView2 in HoloLens 2 Unity apps +# href: webview2/platforms/hololens-2-unity.md - - name: HoloLens 2 + - name: Get started with WebView2 in HoloLens 2 Unity apps (Preview) href: webview2/get-started/hololens2.md - displayName: HoloLens2_GettingStarted, Get started with WebView2 in HoloLens 2 Unity apps (Preview) # repo dir name # top-of-page title + displayName: HoloLens2_GettingStarted # repo dir name + + - name: WebView2 sample apps + href: webview2/code-samples-links.md # delete & redir? + + - name: Getting Started tutorials + href: webview2/get-started/get-started.md # delete & redir? + displayName: GettingStartedGuides # repo dir name # ----------------------------------------------------------------------------- - name: "Main classes for WebView2: Environment, Controller, and Core" href: webview2/concepts/environment-controller-core.md - - name: Navigation events + - name: Navigation events for WebView2 apps href: webview2/concepts/navigation-events.md - displayName: Navigation events for WebView2 apps # top-of-page title - - name: Handle process-related events + - name: Handling process-related events in WebView2 href: webview2/concepts/process-related-events.md - displayName: Handle process-related events in WebView2 # top-of-page title - - name: Basic authentication + - name: Basic authentication for WebView2 apps href: webview2/concepts/basic-authentication.md - displayName: auth, Basic authentication for WebView2 apps # top-of-page title - name: Windowed vs. visual hosting of WebView2 href: webview2/concepts/windowed-vs-visual-hosting.md @@ -1351,6 +1368,9 @@ # ----------------------------------------------------------------------------- - name: Customization and UI items: + - name: Customize the UI of WebView2 apps + href: webview2/how-to/customize-ui.md + - name: WebView2 browser flags # todo: move entry href: webview2/concepts/webview-features-flags.md @@ -1358,9 +1378,9 @@ href: webview2/how-to/webresourcerequested.md displayName: WebResourceRequested, WebResourceResponseReceived - - name: Using frames + - name: Using frames in WebView2 apps href: webview2/concepts/frames.md - displayName: Using frames in WebView2 apps, iframe # full title + displayName: iframe - name: Printing from WebView2 apps href: webview2/how-to/print.md @@ -1368,22 +1388,16 @@ - name: Use local content in WebView2 apps href: webview2/concepts/working-with-local-content.md - # - name: Customize the UI # not needed? flatten - # items: - # - name: Customize the UI of WebView2 apps - # href: webview2/how-to/customize-ui.md - # displayName: context menu, right-click menu - - - name: Customize context menus + - name: Customize context menus in WebView2 href: webview2/how-to/context-menus.md - displayName: right-click menu, Customize context menus in WebView2 # top-of-page title + displayName: right-click menu # ----------------------------------------------------------------------------- - name: Web and native interop items: - name: Interop of native and web code href: webview2/how-to/communicate-btwn-web-native.md - displayName: JavaScript interop, Embed web content into native applications (JavaScript interop), Interop of native-side and web-side code # old titles + displayName: JavaScript interop, Embed web content into native applications (JavaScript interop) # old title - name: Call web-side code from native-side code href: webview2/how-to/javascript.md @@ -1403,9 +1417,8 @@ # ----------------------------------------------------------------------------- - name: Distribution and SDK versions items: - - name: Deployment and distribution # new firstchild page + - name: Deployment and distribution href: webview2/concepts/deployment-distribution.md - displayName: Manage WebView2 applications # old title - name: Deployment samples items: @@ -1449,23 +1462,21 @@ - name: Test upcoming APIs and features href: webview2/how-to/set-preview-channel.md - - name: Development best practices + - name: Development best practices for WebView2 apps href: webview2/concepts/developer-guide.md - displayName: Development best practices for WebView2 apps # top-of-page title - name: Develop secure WebView2 apps href: webview2/concepts/security.md - - name: Use the Chrome DevTools Protocol (CDP) + - name: Use the Chrome DevTools Protocol (CDP) in WebView2 apps href: webview2/how-to/chromium-devtools-protocol.md - displayName: Use the Chrome DevTools Protocol (CDP) in WebView2 apps, chrome developer protocol # top-of-page title & catch a mis-type + displayName: chrome developer protocol # catch mis-expansion - name: Use Playwright to automate and test in WebView2 href: webview2/how-to/playwright.md - - name: Automate and test with Microsoft Edge WebDriver + - name: Automate and test WebView2 apps with Microsoft Edge WebDriver href: webview2/how-to/webdriver.md - displayName: Automate and test WebView2 apps with Microsoft Edge WebDriver # top-of-page title - name: Prerelease testing using preview channels href: webview2/how-to/prerelease-testing.md @@ -1497,17 +1508,17 @@ href: webview2/how-to/remote-debugging.md displayName: remotely debug - - name: Desktop + - name: Remote debugging desktop WebView2 WinUI 2 (UWP) apps href: webview2/how-to/remote-debugging-desktop.md - displayName: Remote debugging desktop WebView2 WinUI 2 (UWP) apps, remotely debug, Remote Tools for Microsoft Edge # top-of-page title + 2 add'l + displayName: remotely debug, Remote Tools for Microsoft Edge - - name: HoloLens 2 + - name: Remote debugging HoloLens 2 WebView2 WinUI 2 (UWP) apps href: webview2/how-to/remote-debugging-hololens.md - displayName: Remote debugging HoloLens 2 WebView2 WinUI 2 (UWP) apps, remotely debug, Remote Tools for Microsoft Edge # top-of-page title + 2 add'l + displayName: remotely debug, Remote Tools for Microsoft Edge - - name: Xbox + - name: Remote debugging Xbox WebView2 WinUI 2 (UWP) apps href: webview2/how-to/remote-debugging-xbox.md - displayName: Remote debugging Xbox WebView2 WinUI 2 (UWP) apps, remotely debug # top-of-page title + 1 add'l + displayName: remotely debug # ----------------------------------------------------------------------------- - name: Architecture @@ -1538,7 +1549,6 @@ href: webview2/concepts/data-privacy.md # ----------------------------------------------------------------------------- -# relnotes - name: Release Notes items: - name: About Release Notes for the WebView2 SDK @@ -1559,7 +1569,7 @@ items: - name: WebView2 API Reference href: webview2/webview2-api-reference.md - displayName: functions, methods # list relevant platforms + displayName: functions, methods, .NET, HoloLens, WinRT, Win32, JavaScript # buckets not in "Filter by title" - name: .NET items: @@ -1627,9 +1637,10 @@ - name: Contact the WebView2 team href: webview2/contact.md displayName: feedback, log issues, enter issues, report issues, reporting issues, support -# / WebView2 articles +# / WebView2 # ============================================================================= +# Test and automation - name: Test and automation items: - name: Test and automation in Microsoft Edge # new firstchild article @@ -1662,8 +1673,10 @@ - name: webhint extension for Visual Studio Code href: test-and-automation/webhint.md +# /Test and automation # ============================================================================= +# Development tips (Web platform) - name: Development tips for Microsoft Edge items: - name: Development tips for Microsoft Edge @@ -1701,8 +1714,10 @@ - name: Sign up for the Ad Selection API href: ./web-platform/ad-selection-api.md +# /Development tips (Web platform) # ============================================================================= +# Microsoft Edge IDE integration - name: Microsoft Edge IDE integration items: - name: Microsoft Edge IDE integration @@ -1720,8 +1735,10 @@ - name: Visual Studio for web development href: visual-studio/index.md +# /Microsoft Edge IDE integration # ============================================================================= +# Accessibility in Microsoft Edge - name: Accessibility in Microsoft Edge items: - name: Accessibility in Microsoft Edge @@ -1738,6 +1755,7 @@ - name: Resources for accessibility testing href: accessibility/test.md +# /Accessibility in Microsoft Edge #============================================================================== # DualEngine @@ -1759,6 +1777,7 @@ - name: DualEngine Win32 C++ Reference href: dualengine/reference/index.md displayName: functions, methods +# /DualEngine # ============================================================================= # bottom leaf nodes From e357d7ccaca625646b20da395218f3c616f73892 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Thu, 7 Nov 2024 08:20:53 -0800 Subject: [PATCH 15/25] plats bucket --- microsoft-edge/toc.yml | 142 +++++++++++++++++++++-------------------- 1 file changed, 72 insertions(+), 70 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 7711cb0040..b0a31d6122 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1256,98 +1256,100 @@ # ----------------------------------------------------------------------------- # Platforms: Intro, Samples, GetStarts - - name: Win32 + - name: Platforms, samples, and tutorials items: -# - name: WebView2 in Win32 apps -# href: webview2/platforms/win32.md + - name: Win32 + items: +# - name: WebView2 in Win32 apps +# href: webview2/platforms/win32.md - - name: Win32 sample app - href: webview2/samples/webview2apissample.md - displayName: WebView2APISample, SampleApps # repo dir names + - name: Win32 sample app + href: webview2/samples/webview2apissample.md + displayName: WebView2APISample, SampleApps # repo dir names - - name: Win32 sample app with Visual Composition - href: webview2/samples/webview2samplewincomp.md - displayName: WebView2SampleWinComp # repo dir name + - name: Win32 sample app with Visual Composition + href: webview2/samples/webview2samplewincomp.md + displayName: WebView2SampleWinComp # repo dir name - - name: Win32 sample WebView2Browser - href: webview2/samples/webview2browser.md - displayName: WebView2Browser # repo dir name + - name: Win32 sample WebView2Browser + href: webview2/samples/webview2browser.md + displayName: WebView2Browser # repo dir name - - name: Get started with WebView2 in Win32 apps - href: webview2/get-started/win32.md - displayName: Win32_GettingStarted # repo dir name + - name: Get started with WebView2 in Win32 apps + href: webview2/get-started/win32.md + displayName: Win32_GettingStarted # repo dir name - - name: WinUI 2 (UWP) - items: -# - name: WebView2 in WinUI 2 (UWP) apps -# href: webview2/platforms/winui2-uwp.md + - name: WinUI 2 (UWP) + items: +# - name: WebView2 in WinUI 2 (UWP) apps +# href: webview2/platforms/winui2-uwp.md - - name: WinUI 2 (UWP) sample app - href: webview2/samples/webview2_sample_uwp.md - displayName: webview2_sample_uwp # repo dir name + - name: WinUI 2 (UWP) sample app + href: webview2/samples/webview2_sample_uwp.md + displayName: webview2_sample_uwp # repo dir name - - name: Get started with WebView2 in WinUI 2 (UWP) apps - href: webview2/get-started/winui2.md - displayName: WinUI2_GettingStarted # repo dir name + - name: Get started with WebView2 in WinUI 2 (UWP) apps + href: webview2/get-started/winui2.md + displayName: WinUI2_GettingStarted # repo dir name - - name: WinUI 3 (Windows App SDK) - items: -# - name: WebView2 in WinUI 3 (Windows App SDK) apps -# href: webview2/platforms/winui3-windows-app-sdk.md + - name: WinUI 3 (Windows App SDK) + items: +# - name: WebView2 in WinUI 3 (Windows App SDK) apps +# href: webview2/platforms/winui3-windows-app-sdk.md - - name: WinUI 3 (Windows App SDK) sample app - href: webview2/samples/webview2-winui3-sample.md - displayName: WebView2_WinUI3_Sample # repo dir name + - name: WinUI 3 (Windows App SDK) sample app + href: webview2/samples/webview2-winui3-sample.md + displayName: WebView2_WinUI3_Sample # repo dir name - - name: Get started with WebView2 in WinUI 3 (Windows App SDK) apps - href: webview2/get-started/winui.md - displayName: WinUI3_GettingStarted # repo dir name + - name: Get started with WebView2 in WinUI 3 (Windows App SDK) apps + href: webview2/get-started/winui.md + displayName: WinUI3_GettingStarted # repo dir name - - name: WebView2 in WPF apps - items: -# - name: WebView2 apps on Win32 -# href: webview2/platforms/wpf.md + - name: WebView2 in WPF apps + items: +# - name: WebView2 apps on Win32 +# href: webview2/platforms/wpf.md - - name: WPF sample app - href: webview2/samples/webview2wpfbrowser.md - displayName: WebView2WpfBrowser # repo dir name + - name: WPF sample app + href: webview2/samples/webview2wpfbrowser.md + displayName: WebView2WpfBrowser # repo dir name - - name: WPF sample app with CDP extension - href: webview2/samples/wv2cdpextensionwpfsample.md - displayName: WV2CDPExtensionWPFSample # repo dir name + - name: WPF sample app with CDP extension + href: webview2/samples/wv2cdpextensionwpfsample.md + displayName: WV2CDPExtensionWPFSample # repo dir name - - name: Get started with WebView2 in WPF apps - href: webview2/get-started/wpf.md - displayName: WPF_GettingStarted # repo dir name + - name: Get started with WebView2 in WPF apps + href: webview2/get-started/wpf.md + displayName: WPF_GettingStarted # repo dir name - - name: WinForms - items: -# - name: WebView2 in WinForms apps -# href: webview2/platforms/winforms.md + - name: WinForms + items: +# - name: WebView2 in WinForms apps +# href: webview2/platforms/winforms.md - - name: WinForms sample app - href: webview2/samples/webview2windowsformsbrowser.md - displayName: WebView2WindowsFormsBrowser # repo dir name + - name: WinForms sample app + href: webview2/samples/webview2windowsformsbrowser.md + displayName: WebView2WindowsFormsBrowser # repo dir name - - name: Get started with WebView2 in WinForms apps - href: webview2/get-started/winforms.md - displayName: WinForms_GettingStarted # repo dir name + - name: Get started with WebView2 in WinForms apps + href: webview2/get-started/winforms.md + displayName: WinForms_GettingStarted # repo dir name - - name: HoloLens 2 Unity - items: -# - name: WebView2 in HoloLens 2 Unity apps -# href: webview2/platforms/hololens-2-unity.md + - name: HoloLens 2 Unity + items: +# - name: WebView2 in HoloLens 2 Unity apps +# href: webview2/platforms/hololens-2-unity.md - - name: Get started with WebView2 in HoloLens 2 Unity apps (Preview) - href: webview2/get-started/hololens2.md - displayName: HoloLens2_GettingStarted # repo dir name + - name: Get started with WebView2 in HoloLens 2 Unity apps (Preview) + href: webview2/get-started/hololens2.md + displayName: HoloLens2_GettingStarted # repo dir name - - name: WebView2 sample apps - href: webview2/code-samples-links.md # delete & redir? + - name: WebView2 sample apps + href: webview2/code-samples-links.md # delete & redir? - - name: Getting Started tutorials - href: webview2/get-started/get-started.md # delete & redir? - displayName: GettingStartedGuides # repo dir name + - name: Getting Started tutorials + href: webview2/get-started/get-started.md # delete & redir? + displayName: GettingStartedGuides # repo dir name # ----------------------------------------------------------------------------- - name: "Main classes for WebView2: Environment, Controller, and Core" From 85dd82e8775aaf783465c5f80a9e810ffba8f35d Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Thu, 7 Nov 2024 08:33:21 -0800 Subject: [PATCH 16/25] Platforms --- microsoft-edge/toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index b0a31d6122..65ffad071d 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1256,7 +1256,7 @@ # ----------------------------------------------------------------------------- # Platforms: Intro, Samples, GetStarts - - name: Platforms, samples, and tutorials + - name: Platforms items: - name: Win32 items: From 09b2c9f1f473043d41ee1fede070f2620652a71c Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Thu, 7 Nov 2024 08:51:46 -0800 Subject: [PATCH 17/25] Platforms and samples --- microsoft-edge/toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 65ffad071d..027a0115fe 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1256,7 +1256,7 @@ # ----------------------------------------------------------------------------- # Platforms: Intro, Samples, GetStarts - - name: Platforms + - name: Platforms and samples items: - name: Win32 items: From cedd5f2f51a1e03fcb2593f09514466a4bbe6b92 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 13:00:05 -0800 Subject: [PATCH 18/25] demote roadmap --- microsoft-edge/toc.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 027a0115fe..ff0f43726b 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1563,10 +1563,11 @@ - name: Archived Release Notes for the WebView2 SDK href: webview2/release-notes/archive.md -# ----------------------------------------------------------------------------- - - name: WebView2 Roadmap - href: webview2/roadmap.md + - name: WebView2 Roadmap + href: webview2/roadmap.md + +# ----------------------------------------------------------------------------- - name: WebView2 Reference items: - name: WebView2 API Reference From 241be23e836ed0f0bff67a4b17bf6592bf8a3725 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 13:07:25 -0800 Subject: [PATCH 19/25] group nav, events, auth --- microsoft-edge/toc.yml | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index ff0f43726b..7f7cb68bc3 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1355,14 +1355,17 @@ - name: "Main classes for WebView2: Environment, Controller, and Core" href: webview2/concepts/environment-controller-core.md - - name: Navigation events for WebView2 apps - href: webview2/concepts/navigation-events.md + - name: Navigation, events, and authentication + items: + + - name: Navigation events for WebView2 apps + href: webview2/concepts/navigation-events.md - - name: Handling process-related events in WebView2 - href: webview2/concepts/process-related-events.md + - name: Handling process-related events in WebView2 + href: webview2/concepts/process-related-events.md - - name: Basic authentication for WebView2 apps - href: webview2/concepts/basic-authentication.md + - name: Basic authentication for WebView2 apps + href: webview2/concepts/basic-authentication.md - name: Windowed vs. visual hosting of WebView2 href: webview2/concepts/windowed-vs-visual-hosting.md From d68781bc6a860b363f896871184618a4e3f04377 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 13:21:32 -0800 Subject: [PATCH 20/25] fix dbl-nested Debug --- microsoft-edge/toc.yml | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 7f7cb68bc3..22c77d54ca 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1494,18 +1494,16 @@ - name: Debug WebView2 apps items: - name: Debug WebView2 apps - items: - - name: Debug WebView2 apps - href: webview2/how-to/debug.md + href: webview2/how-to/debug.md - - name: Debug WebView2 apps with Microsoft Edge DevTools - href: webview2/how-to/debug-devtools.md + - name: Debug WebView2 apps with Microsoft Edge DevTools + href: webview2/how-to/debug-devtools.md - - name: Debug WebView2 apps with Visual Studio Code - href: webview2/how-to/debug-visual-studio-code.md + - name: Debug WebView2 apps with Visual Studio Code + href: webview2/how-to/debug-visual-studio-code.md - - name: Debug WebView2 apps with Visual Studio - href: webview2/how-to/debug-visual-studio.md + - name: Debug WebView2 apps with Visual Studio + href: webview2/how-to/debug-visual-studio.md - name: Remote debugging WebView2 WinUI 2 (UWP) apps items: From dcf0ce7daac5e5514476d6ccb3243de0f6c6824b Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 13:27:39 -0800 Subject: [PATCH 21/25] process/threading model --- microsoft-edge/toc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 22c77d54ca..744f978e00 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1524,10 +1524,10 @@ displayName: remotely debug # ----------------------------------------------------------------------------- - - name: Architecture + - name: Process and threading model # name: Architecture items: # - name: Architecture of WebView2 - # href: webview2/concepts/architecture.md + # href: webview2/concepts/architecture.md # not created - name: Process model for WebView2 apps href: webview2/concepts/process-model.md From 31fecef048201e09954831b985c10f0b44c5d099 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 13:43:50 -0800 Subject: [PATCH 22/25] cmts to del debug.md in new PR --- .../progressive-web-apps-chromium/how-to/service-workers.md | 2 +- microsoft-edge/webview2/how-to/debug.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/microsoft-edge/progressive-web-apps-chromium/how-to/service-workers.md b/microsoft-edge/progressive-web-apps-chromium/how-to/service-workers.md index 943fce309a..18c778a76b 100644 --- a/microsoft-edge/progressive-web-apps-chromium/how-to/service-workers.md +++ b/microsoft-edge/progressive-web-apps-chromium/how-to/service-workers.md @@ -358,7 +358,7 @@ To learn more, see [Re-engage users with push messages](push.md). Using Microsoft Edge DevTools, you can see if your service worker has been registered correctly, and see which lifecycle state the service worker is currently in. Also, you can debug the JavaScript code in your service worker. -To learn more, see [Debug your service worker](debug.md#debug-your-service-worker). +To learn more, see [Debug your service worker](./debug.md#debug-your-service-worker) in _Debug Progressive Web Apps_. diff --git a/microsoft-edge/webview2/how-to/debug.md b/microsoft-edge/webview2/how-to/debug.md index cb0df2b8db..4d26c477a5 100644 --- a/microsoft-edge/webview2/how-to/debug.md +++ b/microsoft-edge/webview2/how-to/debug.md @@ -9,6 +9,12 @@ ms.subservice: webview ms.date: 09/15/2021 --- # Debug WebView2 apps + Debug web code in WebView2 apps by using Microsoft Edge DevTools, Microsoft Visual Studio, or Microsoft Visual Studio Code. Use these tools to debug both web code and native code. From efb6b73ec7e6f9bb588188211d19b2ef89ec10dd Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 13:46:25 -0800 Subject: [PATCH 23/25] overviewapis --- .../experimental-features/index.md | 2 +- .../devtools-protocol-chromium/index.md | 2 +- microsoft-edge/puppeteer/index.md | 2 +- microsoft-edge/toc.yml | 2 +- .../webview2/concepts/data-privacy.md | 6 +++--- .../concepts/environment-controller-core.md | 2 +- microsoft-edge/webview2/concepts/frames.md | 18 +++++++++--------- .../webview2/concepts/multi-profile-support.md | 2 +- .../webview2/concepts/navigation-events.md | 2 +- .../concepts/overview-features-apis.md | 8 ++++---- .../concepts/process-related-events.md | 4 ++-- .../concepts/windowed-vs-visual-hosting.md | 10 +++++----- .../concepts/working-with-local-content.md | 4 ++-- microsoft-edge/webview2/get-started/winui2.md | 8 ++++---- .../how-to/chromium-devtools-protocol.md | 2 +- .../how-to/communicate-btwn-web-native.md | 2 +- .../webview2/how-to/context-menus.md | 2 +- microsoft-edge/webview2/how-to/hostobject.md | 4 ++-- microsoft-edge/webview2/how-to/javascript.md | 2 +- microsoft-edge/webview2/how-to/print.md | 2 +- .../webview2/how-to/webresourcerequested.md | 2 +- microsoft-edge/webview2/index.md | 4 ++-- microsoft-edge/webview2/release-notes/about.md | 4 ++-- .../webview2/release-notes/archive.md | 2 +- microsoft-edge/webview2/release-notes/index.md | 2 +- 25 files changed, 50 insertions(+), 50 deletions(-) diff --git a/microsoft-edge/devtools-guide-chromium/experimental-features/index.md b/microsoft-edge/devtools-guide-chromium/experimental-features/index.md index 08805b433d..d7d78208f7 100644 --- a/microsoft-edge/devtools-guide-chromium/experimental-features/index.md +++ b/microsoft-edge/devtools-guide-chromium/experimental-features/index.md @@ -546,7 +546,7 @@ Adds an **Autofill** tool to DevTools, to record various events that the browser See also: * [Autofill](/legal/microsoft-edge/privacy#autofill) in _Microsoft Edge Privacy Whitepaper_. -* [Autofill](../../webview2/concepts/overview-features-apis.md?tabs=dotnetcsharp#autofill) in _Overview of WebView2 features and APIs_. +* [Autofill](../../webview2/concepts/overview-features-apis.md?tabs=dotnetcsharp#autofill) in _Overview of WebView2 APIs_. Status: * This checkbox is present in Microsoft Edge Canary 131. diff --git a/microsoft-edge/devtools-protocol-chromium/index.md b/microsoft-edge/devtools-protocol-chromium/index.md index 999708e05a..43fde7cb87 100644 --- a/microsoft-edge/devtools-protocol-chromium/index.md +++ b/microsoft-edge/devtools-protocol-chromium/index.md @@ -277,5 +277,5 @@ JSON object which represents the available API surface for the version of the pr ## See also * [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/) -* [Chrome DevTools Protocol (CDP)](../webview2/concepts/overview-features-apis.md#chrome-devtools-protocol-cdp) in _Overview of WebView2 features and APIs_ +* [Chrome DevTools Protocol (CDP)](../webview2/concepts/overview-features-apis.md#chrome-devtools-protocol-cdp) in _Overview of WebView2 APIs_ * [Use the Chrome DevTools Protocol (CDP) in WebView2 apps](../webview2/how-to/chromium-devtools-protocol.md) diff --git a/microsoft-edge/puppeteer/index.md b/microsoft-edge/puppeteer/index.md index c83965675b..2c7de69cc0 100644 --- a/microsoft-edge/puppeteer/index.md +++ b/microsoft-edge/puppeteer/index.md @@ -109,7 +109,7 @@ The preceding example demonstrates basic automation and testing scenarios that y * [WebDriver](../webdriver-chromium/index.md) * [Contact the Microsoft Edge DevTools team](../devtools-guide-chromium/contact.md) to send feedback about using Puppeteer, puppeteer-core, and Microsoft Edge. -* [Chrome DevTools Protocol (CDP)](../webview2/concepts/overview-features-apis.md#chrome-devtools-protocol-cdp) in _Overview of WebView2 features and APIs_ +* [Chrome DevTools Protocol (CDP)](../webview2/concepts/overview-features-apis.md#chrome-devtools-protocol-cdp) in _Overview of WebView2 APIs_ * [Use the Chrome DevTools Protocol (CDP) in WebView2 apps](../webview2/how-to/chromium-devtools-protocol.md) #### Archive diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 744f978e00..01ab5708e3 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1245,7 +1245,7 @@ - name: Introduction to Microsoft Edge WebView2 href: webview2/index.md - - name: Overview of WebView2 features and APIs + - name: Overview of WebView2 APIs href: webview2/concepts/overview-features-apis.md - name: Differences between Microsoft Edge and WebView2 diff --git a/microsoft-edge/webview2/concepts/data-privacy.md b/microsoft-edge/webview2/concepts/data-privacy.md index a55f9953fd..5d15968189 100644 --- a/microsoft-edge/webview2/concepts/data-privacy.md +++ b/microsoft-edge/webview2/concepts/data-privacy.md @@ -76,7 +76,7 @@ If you don't disable SmartScreen, you must provide notice to all users that your --- See also: -* [SmartScreen](../concepts/overview-features-apis.md#smartscreen) in _Overview of WebView2 features and APIs_. +* [SmartScreen](../concepts/overview-features-apis.md#smartscreen) in _Overview of WebView2 APIs_. * [Spec: Disable SmartScreen](https://github.com/MicrosoftEdge/WebView2Feedback/blob/main/specs/IsSmartScreenRequired.md) @@ -111,7 +111,7 @@ If any WebView2 process crashes, one or more minidump files are created and sent --- See also: -* [Custom crash reporting](../concepts/overview-features-apis.md#custom-crash-reporting) in _Overview of WebView2 features and APIs_. +* [Custom crash reporting](../concepts/overview-features-apis.md#custom-crash-reporting) in _Overview of WebView2 APIs_. * [Spec: Custom Crash Reports](https://github.com/MicrosoftEdge/WebView2Feedback/blob/main/specs/DisableCrashReporting.md) * [Minidump Files](/windows/win32/debug/minidump-files) @@ -119,4 +119,4 @@ See also: ## See also -* [Security and privacy](../concepts/overview-features-apis.md#security-and-privacy) in _Overview of WebView2 features and APIs_. +* [Security and privacy](../concepts/overview-features-apis.md#security-and-privacy) in _Overview of WebView2 APIs_. diff --git a/microsoft-edge/webview2/concepts/environment-controller-core.md b/microsoft-edge/webview2/concepts/environment-controller-core.md index 42a3fc3582..45630c43be 100644 --- a/microsoft-edge/webview2/concepts/environment-controller-core.md +++ b/microsoft-edge/webview2/concepts/environment-controller-core.md @@ -11,7 +11,7 @@ ms.date: 06/24/2022 # Main classes for WebView2: Environment, Controller, and Core diff --git a/microsoft-edge/webview2/concepts/frames.md b/microsoft-edge/webview2/concepts/frames.md index 004c6eb06b..33c66f8072 100644 --- a/microsoft-edge/webview2/concepts/frames.md +++ b/microsoft-edge/webview2/concepts/frames.md @@ -21,7 +21,7 @@ WebView2 supports APIs to interact with iframes. You can: * Allow the app to ignore the `X-Frame-Options` HTTP response header. See also: -* [iframes](./overview-features-apis.md#iframes) in _Overview of WebView2 features and APIs_. +* [iframes](./overview-features-apis.md#iframes) in _Overview of WebView2 APIs_. * [HTML Tag](https://www.w3schools.com/tags/tag_iframe.asp) @@ -56,7 +56,7 @@ Your host app must monitor the lifetime of a frame by subscribing to the `CoreWe --- See also: -* [iframes](./overview-features-apis.md#iframes) in _Overview of WebView2 features and APIs_. +* [iframes](./overview-features-apis.md#iframes) in _Overview of WebView2 APIs_. @@ -137,8 +137,8 @@ Regarding the duplicated equivalent `NavigationStarting` and `NavigationComplete See also: * [Standard sequence of events](./navigation-events.md) in _Navigation events for WebView2 apps_. -* [Navigation events](./overview-features-apis.md#navigation-events) in _Overview of WebView2 features and APIs_. -* [Block unwanted navigating](./overview-features-apis.md#block-unwanted-navigating) in _Overview of WebView2 features and APIs_. +* [Navigation events](./overview-features-apis.md#navigation-events) in _Overview of WebView2 APIs_. +* [Block unwanted navigating](./overview-features-apis.md#block-unwanted-navigating) in _Overview of WebView2 APIs_. @@ -194,7 +194,7 @@ See [Step 6: Call AddHostObjectToScript to pass the host object to web-side code See also: -* [Host/web object sharing](./overview-features-apis.md#hostweb-object-sharing) in _Overview of WebView2 features and APIs_. +* [Host/web object sharing](./overview-features-apis.md#hostweb-object-sharing) in _Overview of WebView2 APIs_. @@ -250,7 +250,7 @@ window.chrome.webview.addEventListener('message', arg => { See also: * [Interop of native-side and web-side code](/microsoft-edge/webview2/how-to/communicate-btwn-web-native) -* [Web messaging](./overview-features-apis.md#web-messaging) in _Overview of WebView2 features and APIs_. +* [Web messaging](./overview-features-apis.md#web-messaging) in _Overview of WebView2 APIs_. @@ -300,7 +300,7 @@ See also: For iframes, you can listen to network events and modify them, by using the `WebResourceRequested` event. See also: -* [Manage network requests in WebView2](./overview-features-apis.md#manage-network-requests-in-webview2) in _Overview of WebView2 features and APIs_. +* [Manage network requests in WebView2](./overview-features-apis.md#manage-network-requests-in-webview2) in _Overview of WebView2 APIs_. * [Custom management of network requests](../how-to/webresourcerequested.md) * [Experimental APIs for 1.0.1222-prerelease](../release-notes/archive.md#experimental-apis-for-101222-prerelease) in _Archived Release Notes for the WebView2 SDK_. @@ -477,7 +477,7 @@ if (webview2_4) ## API Reference overview -The following features, listed in [Overview of WebView2 features and APIs](./overview-features-apis.md), include frame-related APIs: +The following features, listed in [Overview of WebView2 APIs](./overview-features-apis.md), include frame-related APIs: * [Host/web object sharing](./overview-features-apis.md#hostweb-object-sharing) * [iframes](./overview-features-apis.md#iframes) diff --git a/microsoft-edge/webview2/concepts/multi-profile-support.md b/microsoft-edge/webview2/concepts/multi-profile-support.md index eb9aa2b0a5..0f18523746 100644 --- a/microsoft-edge/webview2/concepts/multi-profile-support.md +++ b/microsoft-edge/webview2/concepts/multi-profile-support.md @@ -304,7 +304,7 @@ HRESULT AppWindow::OnCreateCoreWebView2ControllerCompleted(HRESULT result, ICore ## See also -* [Multiple profiles](./overview-features-apis.md#multiple-profiles) in _Overview of WebView2 features and APIs_. +* [Multiple profiles](./overview-features-apis.md#multiple-profiles) in _Overview of WebView2 APIs_. * [Manage the user data folder](user-data-folder.md) * [Clear browsing data from the user data folder](clear-browsing-data.md) * [Spec for multiple profile support API](https://github.com/MicrosoftEdge/WebView2Feedback/blob/main/specs/MultiProfile.md) diff --git a/microsoft-edge/webview2/concepts/navigation-events.md b/microsoft-edge/webview2/concepts/navigation-events.md index 49b308d69e..2344c7cc06 100644 --- a/microsoft-edge/webview2/concepts/navigation-events.md +++ b/microsoft-edge/webview2/concepts/navigation-events.md @@ -90,7 +90,7 @@ The [WebView2 sample apps](../code-samples-links.md) also demonstrate handling n ## See also -* [Navigate to pages and manage loaded content](./overview-features-apis.md#navigate-to-pages-and-manage-loaded-content) in _Overview of WebView2 features and APIs_ +* [Navigate to pages and manage loaded content](./overview-features-apis.md#navigate-to-pages-and-manage-loaded-content) in _Overview of WebView2 APIs_ * [Basic authentication for WebView2 apps](./basic-authentication.md) * [Get started with WebView2](../get-started/get-started.md) * [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples) - a comprehensive example of WebView2 capabilities. diff --git a/microsoft-edge/webview2/concepts/overview-features-apis.md b/microsoft-edge/webview2/concepts/overview-features-apis.md index 19a6d1d021..7acb15a8a4 100644 --- a/microsoft-edge/webview2/concepts/overview-features-apis.md +++ b/microsoft-edge/webview2/concepts/overview-features-apis.md @@ -1,6 +1,6 @@ --- -title: Overview of WebView2 features and APIs -description: Overview of WebView2 features and APIs. +title: Overview of WebView2 APIs +description: Overview of WebView2 APIs. author: MSEdgeTeam ms.author: msedgedevrel ms.topic: conceptual @@ -8,7 +8,7 @@ ms.service: microsoft-edge ms.subservice: webview ms.date: 10/21/2024 --- -# Overview of WebView2 features and APIs +# Overview of WebView2 APIs Embedding the WebView2 control in your app gives your app access to various methods and properties that are provided through the WebView2 classes or interfaces. WebView2 has hundreds of APIs that provide a vast set of capabilities, ranging from enhancing your app's native-platform capabilities, to enabling your app to modify browser experiences. This article provides a high-level grouping of the WebView2 APIs to help you understand the different things you can do using WebView2. @@ -47,7 +47,7 @@ This page only lists APIs that are in Release SDKs; it doesn't list Experimental ## Main classes: Environment, Controller, and Core diff --git a/microsoft-edge/webview2/concepts/process-related-events.md b/microsoft-edge/webview2/concepts/process-related-events.md index 5091c027bd..3c72807ba3 100644 --- a/microsoft-edge/webview2/concepts/process-related-events.md +++ b/microsoft-edge/webview2/concepts/process-related-events.md @@ -17,7 +17,7 @@ To improve the reliability of your WebView2 application, it is recommended that * [A process rendering content in the WebView2 control has exited unexpectedly](#a-process-rendering-content-in-the-webview2-control-has-exited-unexpectedly). * [A renderer process becomes unresponsive](#handle-unresponsive-renderers). -To use this article, we recommend first reading [Process model for WebView2 apps](./process-model.md). For a list of process-related APIs covered by this article, see [Process management](overview-features-apis.md#process-management) in _Overview of WebView2 features and APIs_. +To use this article, we recommend first reading [Process model for WebView2 apps](./process-model.md). For a list of process-related APIs covered by this article, see [Process management](overview-features-apis.md#process-management) in _Overview of WebView2 APIs_. #### APIs for Windowed hosting -For a list of APIs that can be used when configuring WebView2 for Windowed hosting (or for Window to Visual hosting), see [Rendering WebView2 in non-framework apps](./overview-features-apis.md#rendering-webview2-in-non-framework-apps) in _Overview of WebView2 features and APIs_. +For a list of APIs that can be used when configuring WebView2 for Windowed hosting (or for Window to Visual hosting), see [Rendering WebView2 in non-framework apps](./overview-features-apis.md#rendering-webview2-in-non-framework-apps) in _Overview of WebView2 APIs_. @@ -110,7 +110,7 @@ See also: #### APIs for Window to Visual hosting -For a list of APIs that can be used when configuring WebView2 Window to Visual hosting (or for Windowed hosting), see [Rendering WebView2 in non-framework apps](./overview-features-apis.md#rendering-webview2-in-non-framework-apps) in _Overview of WebView2 features and APIs_. +For a list of APIs that can be used when configuring WebView2 Window to Visual hosting (or for Windowed hosting), see [Rendering WebView2 in non-framework apps](./overview-features-apis.md#rendering-webview2-in-non-framework-apps) in _Overview of WebView2 APIs_. @@ -126,7 +126,7 @@ When using _Visual hosting_, your host app receives spatial input (such as mouse Per composition-based rendering, a WebView2 control is part of a Visual tree, so by default, it's rendered at a scale that's based on the scales of all of its ancestor Visuals. For example, if a WebView2's ancestor Visual is scaled (zoomed) 2x, then the WebView2's contents are also rendered at 2x scale. If the WebView2's parent Visual is scaled 2x and that Visual's parent is also scaled 2x, then the WebView2 is scaled 4x. But because the WebView2 isn't scaling its own contents, they're blurry. -To resolve this, the app can undo the default Visual scaling of the WebView2, and instead use the Rasterization Scale APIs to apply the intended Visual scaling. This results in the WebView2's contents rendering at the correct scale. See [Rasterization scale](./overview-features-apis.md#rasterization-scale) in _Overview of WebView2 features and APIs_. +To resolve this, the app can undo the default Visual scaling of the WebView2, and instead use the Rasterization Scale APIs to apply the intended Visual scaling. This results in the WebView2's contents rendering at the correct scale. See [Rasterization scale](./overview-features-apis.md#rasterization-scale) in _Overview of WebView2 APIs_. @@ -152,7 +152,7 @@ For example, if a user action causes the WebView2's Visual tree to scale, the ap #### APIs for Visual hosting -For a list of APIs that can be used when configuring WebView2 in a Visual hosting environment, see [Rendering WebView2 using Composition](./overview-features-apis.md#rendering-webview2-using-composition) in _Overview of WebView2 features and APIs_. +For a list of APIs that can be used when configuring WebView2 in a Visual hosting environment, see [Rendering WebView2 using Composition](./overview-features-apis.md#rendering-webview2-using-composition) in _Overview of WebView2 APIs_. @@ -180,7 +180,7 @@ See also: ## See also -* [Overview of WebView2 features and APIs](./overview-features-apis.md) +* [Overview of WebView2 APIs](./overview-features-apis.md) * [Windows 7 and 8](../index.md#windows-7-and-8) in _Introduction to Microsoft Edge WebView2_. diff --git a/microsoft-edge/webview2/concepts/working-with-local-content.md b/microsoft-edge/webview2/concepts/working-with-local-content.md index 253e0b8e66..b17318dc24 100644 --- a/microsoft-edge/webview2/concepts/working-with-local-content.md +++ b/microsoft-edge/webview2/concepts/working-with-local-content.md @@ -434,7 +434,7 @@ From WebView2's perspective, the resource will have come via the network, and We #### Custom scheme registration -If you want to use a custom scheme to make the Web Resource Request that generates the `WebResourceRequested` event, see [Custom scheme registration](./overview-features-apis.md#custom-scheme-registration) in _Overview of WebView2 features and APIs_. +If you want to use a custom scheme to make the Web Resource Request that generates the `WebResourceRequested` event, see [Custom scheme registration](./overview-features-apis.md#custom-scheme-registration) in _Overview of WebView2 APIs_. @@ -823,6 +823,6 @@ HRESULT AppWindow::WebResourceRequestedEventHandler( ## See also -* [Manage content loaded into WebView2](./overview-features-apis.md#manage-content-loaded-into-webview2) in _Overview of WebView2 features and APIs_ +* [Manage content loaded into WebView2](./overview-features-apis.md#manage-content-loaded-into-webview2) in _Overview of WebView2 APIs_ * [Demo To Do rendered page](https://microsoftedge.github.io/Demos/demo-to-do/) * [Demo To Do source code](https://github.com/MicrosoftEdge/Demos/tree/main/demo-to-do) diff --git a/microsoft-edge/webview2/get-started/winui2.md b/microsoft-edge/webview2/get-started/winui2.md index b31c67d0a1..23cc62d193 100644 --- a/microsoft-edge/webview2/get-started/winui2.md +++ b/microsoft-edge/webview2/get-started/winui2.md @@ -308,7 +308,7 @@ The WebView2 WinUI 2 (UWP) control is in development. Autofill UI is not implemented yet for WebView2 for UWP apps. See also: -* [Autofill](../concepts/overview-features-apis.md#autofill) in _Overview of WebView2 features and APIs_. +* [Autofill](../concepts/overview-features-apis.md#autofill) in _Overview of WebView2 APIs_. @@ -317,7 +317,7 @@ See also: Print to PDF requires that the app have access to a writeable location in UWP, such as a local folder. For a full list of UWP-accessible paths, see [File access permissions](/windows/uwp/files/file-access-permissions). See also: -* [Printing](../concepts/overview-features-apis.md#printing) in _Overview of WebView2 features and APIs_. +* [Printing](../concepts/overview-features-apis.md#printing) in _Overview of WebView2 APIs_. @@ -326,7 +326,7 @@ See also: Default printing is disabled for WebView2 for UWP apps. However, you can capture and print the current viewport, by calling `CapturePreview`. See also: -* [Image capture](../concepts/overview-features-apis.md#image-capture) in _Overview of WebView2 features and APIs_. +* [Image capture](../concepts/overview-features-apis.md#image-capture) in _Overview of WebView2 APIs_. @@ -359,7 +359,7 @@ If the host changes the `ResultFilePath` of the downloaded file, the file will o Opening files and folders from the Downloads Hub is disabled. Clicking on the file or folder icon won't open the respective file/folder. See also: -* [Downloads](../concepts/overview-features-apis.md#downloads) in _Overview of WebView2 features and APIs_. +* [Downloads](../concepts/overview-features-apis.md#downloads) in _Overview of WebView2 APIs_. diff --git a/microsoft-edge/webview2/how-to/chromium-devtools-protocol.md b/microsoft-edge/webview2/how-to/chromium-devtools-protocol.md index ffca3161b3..d074a1d90c 100644 --- a/microsoft-edge/webview2/how-to/chromium-devtools-protocol.md +++ b/microsoft-edge/webview2/how-to/chromium-devtools-protocol.md @@ -182,4 +182,4 @@ The Chrome DevTools Protocol is maintained by the open source Chromium project, * [Microsoft Edge DevTools Protocol overview](../../devtools-protocol-chromium/index.md) * [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples) -* [Chrome DevTools Protocol (CDP)](../concepts/overview-features-apis.md#chrome-devtools-protocol-cdp) in _Overview of WebView2 features and APIs_ +* [Chrome DevTools Protocol (CDP)](../concepts/overview-features-apis.md#chrome-devtools-protocol-cdp) in _Overview of WebView2 APIs_ diff --git a/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md b/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md index 1e20915cd3..dc825e4404 100644 --- a/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md +++ b/microsoft-edge/webview2/how-to/communicate-btwn-web-native.md @@ -288,4 +288,4 @@ Congratulations! You've successfully embedded web content into native applicatio ## See also -* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 features and APIs_. +* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 APIs_. diff --git a/microsoft-edge/webview2/how-to/context-menus.md b/microsoft-edge/webview2/how-to/context-menus.md index 45f54e4df3..17c719282d 100644 --- a/microsoft-edge/webview2/how-to/context-menus.md +++ b/microsoft-edge/webview2/how-to/context-menus.md @@ -897,7 +897,7 @@ The `AreDefaultContextMenusEnabled` property controls whether any context menu c ## See also -* [Context menus](../concepts/overview-features-apis.md#context-menus) in _Overview of WebView2 features and APIs_. +* [Context menus](../concepts/overview-features-apis.md#context-menus) in _Overview of WebView2 APIs_. * [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples) diff --git a/microsoft-edge/webview2/how-to/hostobject.md b/microsoft-edge/webview2/how-to/hostobject.md index 25ccb267cc..16497add1b 100644 --- a/microsoft-edge/webview2/how-to/hostobject.md +++ b/microsoft-edge/webview2/how-to/hostobject.md @@ -483,13 +483,13 @@ To find out what other APIs there are in the host object ecosystem, see [WebView ## API Reference overview -See [Host/web object sharing](../concepts/overview-features-apis.md#hostweb-object-sharing) in _Overview of WebView2 features and APIs_. +See [Host/web object sharing](../concepts/overview-features-apis.md#hostweb-object-sharing) in _Overview of WebView2 APIs_. ## See also -* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 features and APIs_. +* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 APIs_. * [Using frames in WebView2 apps](../concepts/frames.md) * [Call native-side WinRT code from web-side code](./winrt-from-js.md) diff --git a/microsoft-edge/webview2/how-to/javascript.md b/microsoft-edge/webview2/how-to/javascript.md index 6cfb0adc52..5f2c6d000d 100644 --- a/microsoft-edge/webview2/how-to/javascript.md +++ b/microsoft-edge/webview2/how-to/javascript.md @@ -150,4 +150,4 @@ To begin, explore the current functionality of the right-click menu: * [Get started with WebView2](../get-started/get-started.md) * [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples) - a comprehensive example of WebView2 capabilities. * [WebView2 API reference](../webview2-api-reference.md) -* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 features and APIs_. +* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 APIs_. diff --git a/microsoft-edge/webview2/how-to/print.md b/microsoft-edge/webview2/how-to/print.md index eb4d9c7c92..3264f79b28 100644 --- a/microsoft-edge/webview2/how-to/print.md +++ b/microsoft-edge/webview2/how-to/print.md @@ -900,7 +900,7 @@ bool AppWindow::PrintToPdfStream() ## See also -* [Printing](../concepts/overview-features-apis.md#printing) in _Overview of WebView2 features and APIs_. +* [Printing](../concepts/overview-features-apis.md#printing) in _Overview of WebView2 APIs_. * [Get started with WebView2](../get-started/get-started.md) * [WebView2Samples repo](https://github.com/MicrosoftEdge/WebView2Samples) - a comprehensive example of WebView2 capabilities. * [WebView2 API reference](/dotnet/api/microsoft.web.webview2.wpf.webview2) diff --git a/microsoft-edge/webview2/how-to/webresourcerequested.md b/microsoft-edge/webview2/how-to/webresourcerequested.md index 7de3a0c0c5..efa84fcb40 100644 --- a/microsoft-edge/webview2/how-to/webresourcerequested.md +++ b/microsoft-edge/webview2/how-to/webresourcerequested.md @@ -588,7 +588,7 @@ m_webView->add_WebResourceResponseReceived( ## See also * [Call native-side code from web-side code](hostobject.md) -* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 features and APIs_. +* [Web/native interop](../concepts/overview-features-apis.md#webnative-interop) in _Overview of WebView2 APIs_. ## See also -* [Overview of WebView2 features and APIs](concepts/overview-features-apis.md) +* [Overview of WebView2 APIs](concepts/overview-features-apis.md) * [Distribute your app and the WebView2 Runtime](concepts/distribution.md) developer.microsoft.com: diff --git a/microsoft-edge/webview2/release-notes/about.md b/microsoft-edge/webview2/release-notes/about.md index 58da77004e..8d225f3168 100644 --- a/microsoft-edge/webview2/release-notes/about.md +++ b/microsoft-edge/webview2/release-notes/about.md @@ -14,7 +14,7 @@ The WebView2 team updates the WebView2 Release SDK and the WebView2 Prerelease S You can view the list of [Microsoft.Web.WebView2](https://www.nuget.org/packages/Microsoft.Web.WebView2) SDK packages at the NuGet site. -Generally, release notes apply across the supported platforms, which are listed in [WebView2 API Reference](../webview2-api-reference.md). For an outline of APIs that are in Release SDK packages, see [Overview of WebView2 features and APIs](../concepts/overview-features-apis.md). +Generally, release notes apply across the supported platforms, which are listed in [WebView2 API Reference](../webview2-api-reference.md). For an outline of APIs that are in Release SDK packages, see [Overview of WebView2 APIs](../concepts/overview-features-apis.md). Release Notes entries correspond to historical releases of WebView2, and are not updated over time. References to "new features" and "experimental APIs" might become outdated as new versions of WebView2 are released. @@ -98,5 +98,5 @@ Async methods: * [Release Notes for the WebView2 SDK](./index.md) * [Archived Release Notes for the WebView2 SDK](./archive.md) -* [Overview of WebView2 features and APIs](../concepts/overview-features-apis.md) +* [Overview of WebView2 APIs](../concepts/overview-features-apis.md) * [Contacting the Microsoft Edge WebView2 team](../contact.md) diff --git a/microsoft-edge/webview2/release-notes/archive.md b/microsoft-edge/webview2/release-notes/archive.md index 85fdb4102a..daa9ac66da 100644 --- a/microsoft-edge/webview2/release-notes/archive.md +++ b/microsoft-edge/webview2/release-notes/archive.md @@ -6652,5 +6652,5 @@ Initial developer preview release. * [About Release Notes for the WebView2 SDK](./about.md) * [Release Notes for the WebView2 SDK](./index.md) -* [Overview of WebView2 features and APIs](../concepts/overview-features-apis.md) - outlines many of the APIs, by feature area, that are in Release SDK packages. +* [Overview of WebView2 APIs](../concepts/overview-features-apis.md) - outlines many of the APIs, by feature area, that are in Release SDK packages. * [Contacting the Microsoft Edge WebView2 team](../contact.md) diff --git a/microsoft-edge/webview2/release-notes/index.md b/microsoft-edge/webview2/release-notes/index.md index 5b11689efe..633c6991cc 100644 --- a/microsoft-edge/webview2/release-notes/index.md +++ b/microsoft-edge/webview2/release-notes/index.md @@ -1574,5 +1574,5 @@ No APIs have been promoted from Experimental to Stable in this Prerelease SDK. * [About Release Notes for the WebView2 SDK](./about.md) * [Archived Release Notes for the WebView2 SDK](./archive.md) -* [Overview of WebView2 features and APIs](../concepts/overview-features-apis.md) - outlines many of the APIs, by feature area, that are in Release SDK packages. +* [Overview of WebView2 APIs](../concepts/overview-features-apis.md) - outlines many of the APIs, by feature area, that are in Release SDK packages. * [Contacting the Microsoft Edge WebView2 team](../contact.md) From e10d541e8e7bf97d85dce9037a1236950ad4897c Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 14:00:03 -0800 Subject: [PATCH 24/25] restore Best practices bucket --- microsoft-edge/toc.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 01ab5708e3..fa1b32b7f7 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1462,17 +1462,20 @@ displayName: Partner Center, Microsoft Store # ----------------------------------------------------------------------------- - - name: Test and automation in WebView2 apps + - name: Best practices items: - - name: Test upcoming APIs and features - href: webview2/how-to/set-preview-channel.md - - name: Development best practices for WebView2 apps href: webview2/concepts/developer-guide.md - name: Develop secure WebView2 apps href: webview2/concepts/security.md +# ----------------------------------------------------------------------------- + - name: Test and automation + items: + - name: Test upcoming APIs and features + href: webview2/how-to/set-preview-channel.md + - name: Use the Chrome DevTools Protocol (CDP) in WebView2 apps href: webview2/how-to/chromium-devtools-protocol.md displayName: chrome developer protocol # catch mis-expansion @@ -1567,7 +1570,6 @@ - name: WebView2 Roadmap href: webview2/roadmap.md - # ----------------------------------------------------------------------------- - name: WebView2 Reference items: From 90a8482c998afda9e2c33bdae04d945f46655503 Mon Sep 17 00:00:00 2001 From: Michael Hoffman Date: Wed, 13 Nov 2024 14:23:06 -0800 Subject: [PATCH 25/25] 2 Test buckets --- microsoft-edge/toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index fa1b32b7f7..6ea41fcbdd 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -1471,7 +1471,7 @@ href: webview2/concepts/security.md # ----------------------------------------------------------------------------- - - name: Test and automation + - name: Test and automation for WebView2 apps # vs. Edge "Test and automation" items: - name: Test upcoming APIs and features href: webview2/how-to/set-preview-channel.md