Skip to content

Document Web Inspector access #97

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.

Sign up for GitHub

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

Open
aditya-vithaldas wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document Web Inspector access #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions changelog.d/web-inspector-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
improvement: **Web Inspector docs**: the debugging guide now explains how macOS WebView apps open the WebKit inspector and points native-rendered UI debugging back to automation snapshots.
6 changes: 6 additions & 0 deletions docs/src/app/debugging/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,12 @@ For apps with [web content](/frontend), build with `-Ddebug-overlay=true` to ena
native dev -Ddebug-overlay=true
```

## Web Inspector

On macOS, apps that declare web content get a WebKit inspector entry in the native View menu. Run the app, focus the WebView window, then choose **View > Toggle Web Inspector** or press <kbd>⌥</kbd><kbd>⌘</kbd><kbd>I</kbd>. Canvas-only apps do not show the item because there is no WebView to inspect.

The inspector is for the web surface: DOM, console, network, storage, and frontend JavaScript. For native-rendered UI state, use [Automation](/automation) snapshots and widget driving instead.

See also [native doctor](/debugging/doctor) for a full diagnostic tool reference.

## Environment variables
Expand Down