GPUI WebView

A webview supports for GPUI, based on Wry.

This crate was previously published as gpui-wry. Replace the dependency with gpui-webview and gpui_wry:: paths with gpui_webview::.

This still a experimental with limited features, please file issues for any bugs or missing features.

Supported platforms:

To render GPUI overlays above the page on macOS and Linux, run the application on GPUI Fast and enable the gpui-fast feature of both crates:

[dependencies]
gpui-kit = { version = "0.7", features = ["gpui-fast"] }
gpui-webview = { version = "0.7", features = ["gpui-fast"] }

• gpui-kit selects the GPUI backend, and this crate's gpui-fast feature follows it. The two must agree: enabling only one of them fails to compile, with an error that names the feature to enable.
• On gpui-pre, the native view is attached to the window directly. It covers GPUI content in its bounds, including popovers, dialogs, menus and tooltips. It cannot be clipped either: when its container clips it only partly, for example in a scrolled region, it keeps its full bounds and extends past the container. It is hidden only when it is scrolled out of view entirely or hidden by the application.
• With gpui-fast on macOS, WebView::new() registers the native view with window composition so GPUI overlays can render above it. Composition failures are logged and fall back to the plain native attachment.
• With gpui-fast on Linux, WebView::build() builds the native view in a window composition surface, with the same fallback.
• Use WebView::set_bounds() and WebView::set_visible() to keep the managed container and Wry child synchronized. Raw Wry handles bypass this coordination.
• Use WebView::build() to attach a webview to a GPUI window with the platform setup Wry needs.
• On Linux, the webview uses WebKitGTK and requires the application to run on X11 (or XWayland in a Wayland session). Start it with gpui_kit::platform::linux(WindowingModes::X11); WebView::build() returns an error on a Wayland window. Wayland is not supported.

On Windows, or without gpui-fast, use the webview in a separate window or a Popup layer when overlapping GPUI content is required.

Run Example

In the root of the repository, run:

cargo run -p webview

License

Apache-2.0