Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redesigned WebView2 TOC #2725

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
6f4d03f
touch toc
mikehoffms Jul 21, 2023
f265ff0
Revise TOC per diagrams PR 2450
mikehoffms Jul 21, 2023
f8174dd
Cap'ize Release SDK
mikehoffms Jul 31, 2023
fb76b53
Merge branch 'main' into pr/2725
mikehoffms Aug 12, 2023
8e4a805
Merge branch 'main' into pr/2725
mikehoffms Aug 19, 2023
fd7afd4
Merge branch 'main' into pr/2725
mikehoffms Aug 29, 2023
b92eb8e
Merge branch 'main' into pr/2725
mikehoffms Aug 31, 2023
aa0ee23
Merge branch 'main' into pr/2725
mikehoffms Sep 5, 2023
1261da5
Merge branch 'main' into pr/2725
mikehoffms Sep 8, 2023
86f8ac3
Merge branch 'main' into pr/2725
mikehoffms Sep 20, 2023
0146439
Merge branch 'main' into pr/2725
mikehoffms Sep 21, 2023
078a69a
Merge branch 'main' into pr/2725
mikehoffms Oct 5, 2023
ad62553
Merge branch 'main' into pr/2725
mikehoffms Oct 24, 2023
348c600
Merge branch 'main' into pr/2725
mikehoffms Nov 14, 2023
1d30ca4
Merge branch 'main' into pr/2725
mikehoffms Nov 15, 2023
cd5c06e
Merge branch 'main' into pr/2725
mikehoffms Nov 30, 2023
39c6a32
Merge remote-tracking branch 'upstream/main' into user/mikehoffms/toc…
mikehoffms Dec 5, 2023
9dc406f
Merge remote-tracking branch 'upstream/main' into user/mikehoffms/toc…
mikehoffms Feb 7, 2024
3dee258
Merge remote-tracking branch 'upstream/main' into user/mikehoffms/toc…
mikehoffms Feb 23, 2024
aba9676
Merge remote-tracking branch 'upstream/main' into user/mikehoffms/toc…
mikehoffms Mar 18, 2024
49f8070
Merge remote-tracking branch 'upstream/main' into user/mikehoffms/toc…
mikehoffms Mar 22, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 84 additions & 92 deletions microsoft-edge/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,7 @@
href: devtools-guide-chromium/accessibility/lighthouse.md
displayName: Lighthouse tool

# ~Elements tool > Accessibility tab
# Elements tool > Accessibility tab
- name: Navigate DevTools with assistive technology
href: devtools-guide-chromium/accessibility/navigation.md
displayName: Elements tool, Accessibility tab # many tools
Expand Down Expand Up @@ -1148,8 +1148,9 @@
- name: Overview of WebView2 features and APIs
href: webview2/concepts/overview-features-apis.md

# -----------------------------------------------------------------------------
# machine setup
- name: Differences between Microsoft Edge and WebView2
href: webview2/concepts/browser-features.md

- name: Set up your Dev environment for WebView2
href: webview2/how-to/machine-setup.md

Expand All @@ -1163,7 +1164,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
Expand Down Expand Up @@ -1194,19 +1195,19 @@

- 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
displayName: WebView2Browser # repo dir name

- 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
Expand All @@ -1215,7 +1216,7 @@

- 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
Expand Down Expand Up @@ -1245,41 +1246,61 @@
displayName: WV2DeploymentWiXCustomActionSample # repo dir name

# -----------------------------------------------------------------------------
- name: Fundamentals
items:
- name: Differences between Microsoft Edge and WebView2
href: webview2/concepts/browser-features.md
- 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: 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: Windowed vs. visual hosting of WebView2
href: webview2/concepts/windowed-vs-visual-hosting.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

- name: Using frames
href: webview2/concepts/frames.md
displayName: Using frames in WebView2 apps, iframe # full title

- name: Printing
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

# - 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
href: webview2/how-to/context-menus.md
displayName: right-click menu, Customize context menus in WebView2 # top-of-page title

# -----------------------------------------------------------------------------
- name: Web and native interop
items:
- name: Interop of native-side and web-side code
- 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) # old title
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
Expand All @@ -1296,40 +1317,55 @@
- 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

- name: Printing
href: webview2/how-to/print.md
displayName: Printing from WebView2 apps # full 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

# updated h2: Experimental APIs, added a 2nd, new h3:
- name: Understand the different WebView2 SDK versions
- name: Prerelease and Release SDKs for WebView2
href: webview2/concepts/versioning.md
displayName: Understand WebView2 SDK versions # old title
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: Working with local content in WebView2 apps
href: webview2/concepts/working-with-local-content.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
items:
- 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

Expand Down Expand Up @@ -1366,7 +1402,6 @@
# -----------------------------------------------------------------------------
- name: Architecture
items:

# - name: Architecture of WebView2
# href: webview2/concepts/architecture.md

Expand All @@ -1391,53 +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 # 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
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:
Expand All @@ -1453,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

Expand Down Expand Up @@ -1524,6 +1515,7 @@
- name: WebView
uid: 'WebView2Script!WebView:class'

# -----------------------------------------------------------------------------
- name: WebView2 end-user FAQ
href: webview2/concepts/end-user-faq.md

Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/concepts/frames.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,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)
* [Interop of native and web 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_.


Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/concepts/overview-features-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions microsoft-edge/webview2/concepts/versioning.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.

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

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

Expand Down
2 changes: 1 addition & 1 deletion microsoft-edge/webview2/how-to/set-preview-channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).


<!-- ====================================================================== -->
Expand Down
Loading