Skip to content

docs: all features #1786

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

Merged
Legend-Master merged 3 commits into from
Jul 27, 2026
Merged

docs: all features #1786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bea42af
docs: all features
Legend-Master Jul 27, 2026
f4e0931
Merge branch 'dev' of https://github.com/tauri-apps/wry into document…
Legend-Master Jul 27, 2026
15fc1ed
Merge branch 'dev' into document-features
Legend-Master Jul 27, 2026
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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,10 +279,11 @@ Wry uses a set of feature flags to toggle several advanced features.
for the crate to work. This feature was added in preparation of other ports like cef and servo.
- `protocol` (default): Enables [`WebViewBuilder::with_custom_protocol`] to define custom URL scheme for handling tasks like
loading assets.
- `drag-drop` (default): Enables [`WebViewBuilder::with_drag_drop_handler`] to control the behavior when there are files
interacting with the window.
- `x11` (default): Enables x11 support and dependencies on Linux.
- `serde`: Enables `dpi`'s `serde` feature.
- `devtools`: Enables devtools on release builds. Devtools are always enabled in debug builds.
On **macOS**, enabling devtools, requires calling private functions, so avoid this in release builds if you publish your app on the App Store.
- `mac-proxy`: Enables `WebViewBuilder::with_proxy_config` on macOS.
- `linux-body`: Enables body support of custom protocol request on Linux. Requires
WebKit2GTK v2.40 or above.
- `tracing`: enables [`tracing`] for `evaluate_script`, `ipc_handler`, and `custom_protocols`.
Expand Down
3 changes: 3 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,9 +301,12 @@
//! for the crate to work. This feature was added in preparation of other ports like cef and servo.
//! - `protocol` (default): Enables [`WebViewBuilder::with_custom_protocol`] to define custom URL scheme for handling tasks like

@Legend-Master Legend-Master Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Actually wonder if we should remove this as well that nothing except the builder methods are still behind the flag

@FabianLars FabianLars Jul 27, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Was there ever a reason for this?

//! loading assets.
//! - `x11` (default): Enables x11 support and dependencies on Linux.
//! - `serde`: Enables `dpi`'s `serde` feature.
Comment thread
Legend-Master marked this conversation as resolved.
//! - `devtools`: Enables devtools on release builds. Devtools are always enabled in debug builds.
//! On **macOS**, enabling devtools, requires calling private APIs so you should not enable this flag in release
//! build if your app needs to publish to App Store.
//! - `mac-proxy`: Enables `WebViewBuilder::with_proxy_config` on macOS.

@Legend-Master Legend-Master Jul 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is from #1006, it's not super clear to me why we needed this in a feature flag for macOS?

From the description in the original PR, it seems like it's only available on later version of macOS but I think that can be gated in a version check?

@FabianLars FabianLars Jul 27, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

#1006 (comment) / https://github.com/tauri-apps/wry/pull/1006/changes#diff-182c0a218443303957d1585b15478976c27894b9104c8caa2527f41f357b7796

I think it could still be an issue nowadays after the objc2 migration because the whole framework was added in 10.14 while we still support 10.13 so i think it could cause build issues (not runtime issues after adding version checks) on 10.13

@Legend-Master Legend-Master Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Will something you tried in #1781 work with this as well?

@FabianLars FabianLars Jul 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not sure, i don't think so because we do have to link the framework at least - at least if i look at objc2-generated it seems like it.

I think in this case we'd need #1776 - or we just drop support for compiling wry on 10.13, running apps should work regardless.
The fck, i forgot what my PR was. Yes it may work

Or i'll try to get a 10.13 vm running again, which i need a bit of time for, and test how things go.

@FabianLars FabianLars Jul 27, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The fck, i forgot what my PR was. Yes it may work

But without the 0.7 annotation, this here would stay until we drop 10.13 support.

//! - `linux-body`: Enables body support of custom protocol request on Linux. Requires
//! WebKit2GTK v2.40 or above.
//! - `tracing`: enables [`tracing`] for `evaluate_script`, `ipc_handler`, and `custom_protocols`.
Expand Down
Loading