WRY (Webview Rendering librarY)

Cross-platfrom WebView rendering library in Rust that supports all major desktop platforms like Windows, macOS, and Linux.

toml [dependencies] wry = "0.9"

Overview

Wry connects the web engine on each platform and provides easy to use and unified interface to render WebView. It also re-export [winit] as a module for event loop and window creation.

Usage

The minimum example to create a Window and browse a website looks like following:

```rust fn main() -> wry::Result<()> { use wry::{ application::{ event::{Event, StartCause, WindowEvent}, event_loop::{ControlFlow, EventLoop}, window::WindowBuilder, }, webview::WebViewBuilder, };

let eventloop = EventLoop::new(); let window = WindowBuilder::new() .withtitle("Hello World") .build(&eventloop)?; let _webview = WebViewBuilder::new(window)? .withurl("https://tauri.studio")? .build()?;

eventloop.run(move |event, _, controlflow| { *control_flow = ControlFlow::Poll;

match event {
  Event::NewEvents(StartCause::Init) => println!("Wry has started!"),
  Event::WindowEvent {
    event: WindowEvent::CloseRequested,
    ..
  } => *control_flow = ControlFlow::Exit,
  _ => (),
}

}); } ```

There are also more samples under examples, you can enter commands like following to try them:

cargo run --example multi_window

For more information, please read the documentation below.

Documentation

Platform-specific notes

All platforms uses winit to build the window. But since Linux needs to use Gtk under the hood, we recommend use wry's application module. It implements a winit APIs on top of Gtk and simplu re-export winit on other platforms.

Here are the underlying web engine each platfrom uses and some dependencies you might need to install.

Linux

Unlike other platforms, gtk-rs is used to build the window instead of winit. Because wry needs WebKitGTK and winit provides lower level of interface like x11 or wayland. Please make sure WebKitGTK is installed. If not, run the following command:

Arch Linux / Manjaro:

bash sudo pacman -S webkit2gtk

Debian / Ubuntu:

bash sudo apt install libwebkit2gtk-4.0-dev

macOS

WebKit is native on macOS so everything should be fine.

If you are cross-compiling for macOS using osxcross and encounter a runtime panic like Class with name WKWebViewConfiguration could not be found it's possible that WebKit.framework has not been linked correctly, to fix this set the RUSTFLAGS environment variable:

RUSTFLAGS="-l framework=WebKit" cargo build --target=x86_64-apple-darwin --release

Windows

WebView2 provided by Microsoft Edge Chromium is used. So wry supports Windows 7, 8, and 10.

License

Apache-2.0/MIT