WRY (Webview Rendering librarY)

Cross-platform 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-exports [tao] 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::Wait;

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 tao to build the window, and wry re-export it as application module. Here are the underlying web engine each platform uses, and some dependencies you might need to install.

Linux

Tao uses gtk-rs and its related libraries for window creation and wry also needs WebKitGTK for WebView. So please make sure following packages are installed:

Arch Linux / Manjaro:

bash sudo pacman -S webkit2gtk gtksourceview3 libappindicator-gtk3 clang

Debian / Ubuntu:

bash sudo apt install libwebkit2gtk-4.0-dev libgtksourceview-3.0-dev libappindicator3-dev clang

Fedora

bash sudo dnf install gtk3-devel webkit2gtk3-devel gtksourceview3-devel libappindicator-gtk3-devel clang

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