[](https://crates.io/crates/wry) [](https://docs.rs/wry/)
[](https://opencollective.com/tauri)
[](https://discord.gg/SpmNs4S)
[](https://tauri.app)
[](https://good-labs.github.io/greater-good-affirmation)
[](https://opencollective.com/tauri)
Cross-platform WebView rendering library in Rust that supports all major desktop platforms like Windows, macOS, and Linux.
## 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.
[tao]: https://crates.io/crates/tao
## 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 event_loop = EventLoop::new();
let window = WindowBuilder::new()
.with_title("Hello World")
.build(&event_loop)?;
let _webview = WebViewBuilder::new(window)?
.with_url("https://tauri.studio")?
.build()?;
event_loop.run(move |event, _, control_flow| {
*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 the following to try them:
```
cargo run --example multi_window
```
For more information, please read the documentation below.
## [Documentation](https://docs.rs/wry)
## Platform-specific notes
All platforms use [TAO](https://github.com/tauri-apps/tao) to build the window, and wry re-exports it as an application module. Here is the underlying web engine each platform uses, and some dependencies you might need to install.
### Linux
Tao uses [gtk-rs](https://gtk-rs.org/) and its related libraries for window creation and wry also needs [WebKitGTK](https://webkitgtk.org/) for WebView. So please make sure the following packages are installed:
#### Arch Linux / Manjaro:
```bash
sudo pacman -S webkit2gtk
sudo pacman -S libappindicator-gtk3 # For tray feature
```
The `libayatana-indicator` package can be installed from the Arch User Repository (AUR).
#### Debian / Ubuntu:
```bash
sudo apt install libwebkit2gtk-4.0-dev
# For tray feature, choose one of following package
sudo apt install libayatana-appindicator3-dev
sudo apt install libappindicator3-dev
```
#### Fedora
```bash
sudo dnf install gtk3-devel webkit2gtk3-devel
# For tray feature
sudo dnf install libappindicator-gtk3-devel
```
Fedora does not have the Ayatana package yet, so you need to use the GTK one, see the [feature flags documentation](https://docs.rs/wry/latest/wry/#feature-flags).
### macOS
WebKit is native on macOS so everything should be fine.
If you are cross-compiling for macOS using [osxcross](https://github.com/tpoechtrager/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, 10 and 11.
### Android / iOS
We have experimental support of mobile ends. If you are interested in playing or hacking it, please follow this [note](https://hackmd.io/XIcEwk4GSxy8APZhSa0UnA?view).
When building for Android, WRY generates kotlin files that are needed to run WRY on Android and you have to set the following environment variables:
- `WRY_ANDROID_REVERSED_DOMAIN`
- `WRY_ANDROID_APP_NAME_SNAKE_CASE`
- `WRY_ANDROID_KOTLIN_FILES_OUT_DIR`
You can skip setting these environment variables if you are using the WRY template from our [`cargo-mobile`](https://github.com/tauri-apps/cargo-mobile) fork.
## License
Apache-2.0/MIT
