base on Cross-platform WebView library in Rust for Tauri. <p align="center"><img height="100" src="https://raw.githubusercontent.com/tauri-apps/wry/refs/heads/dev/.github/splash.png" alt="WRY Webview Rendering library" /></p> [](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) Wry is a Cross-platform WebView rendering library. The webview requires a running event loop and a window type that implements [`HasWindowHandle`], or a gtk container widget if you need to support X11 and Wayland. You can use a windowing library like [`tao`] or [`winit`]. ### Examples This example leverages the [`HasWindowHandle`] and supports Windows, macOS, iOS, Android and Linux (X11 Only). See the following example using [`winit`]: ```rust #[derive(Default)] struct App { window: Option<Window>, webview: Option<wry::WebView>, } impl ApplicationHandler for App { fn resumed(&mut self, event_loop: &ActiveEventLoop) { let window = event_loop.create_window(Window::default_attributes()).unwrap(); let webview = WebViewBuilder::new() .with_url("https://tauri.app") .build(&window) .unwrap(); self.window = Some(window); self.webview = Some(webview); } fn window_event(&mut self, _event_loop: &ActiveEventLoop, _window_id: WindowId, event: WindowEvent) {} } let event_loop = EventLoop::new().unwrap(); let mut app = App::default(); event_loop.run_app(&mut app).unwrap(); ``` If you also want to support Wayland too, then we recommend you use [`WebViewBuilderExtUnix::new_gtk`] on Linux. See the following example using [`tao`]: ```rust let event_loop = EventLoop::new(); let window = WindowBuilder::new().build(&event_loop).unwrap(); let builder = WebViewBuilder::new().with_url("https://tauri.app"); #[cfg(not(target_os = "linux"))] let webview = builder.build(&window).unwrap(); #[cfg(target_os = "linux")] let webview = builder.build_gtk(window.gtk_window()).unwrap(); ``` ### Child webviews You can use [`WebView::new_as_child`] or [`WebViewBuilder::new_as_child`] to create the webview as a child inside another window. This is supported on macOS, Windows and Linux (X11 Only). ```rust #[derive(Default)] struct App { window: Option<Window>, webview: Option<wry::WebView>, } impl ApplicationHandler for App { fn resumed(&mut self, event_loop: &ActiveEventLoop) { let window = event_loop.create_window(Window::default_attributes()).unwrap(); let webview = WebViewBuilder::new() .with_url("https://tauri.app") .with_bounds(Rect { position: LogicalPosition::new(100, 100).into(), size: LogicalSize::new(200, 200).into(), }) .build_as_child(&window) .unwrap(); self.window = Some(window); self.webview = Some(webview); } fn window_event(&mut self, _event_loop: &ActiveEventLoop, _window_id: WindowId, event: WindowEvent) {} } let event_loop = EventLoop::new().unwrap(); let mut app = App::default(); event_loop.run_app(&mut app).unwrap(); ``` If you want to support X11 and Wayland at the same time, we recommend using [`WebViewExtUnix::new_gtk`] or [`WebViewBuilderExtUnix::new_gtk`] with [`gtk::Fixed`]. ```rust let event_loop = EventLoop::new(); let window = WindowBuilder::new().build(&event_loop).unwrap(); let builder = WebViewBuilder::new() .with_url("https://tauri.app") .with_bounds(Rect { position: LogicalPosition::new(100, 100).into(), size: LogicalSize::new(200, 200).into(), }); #[cfg(not(target_os = "linux"))] let webview = builder.build_as_child(&window).unwrap(); #[cfg(target_os = "linux")] let webview = { # use gtk::prelude::*; let vbox = window.default_vbox().unwrap(); // tao adds a gtk::Box by default let fixed = gtk::Fixed::new(); fixed.show_all(); vbox.pack_start(&fixed, true, true, 0); builder.build_gtk(&fixed).unwrap() }; ``` ### Platform Considerations Here is the underlying web engine each platform uses, and some dependencies you might need to install. #### Linux [WebKitGTK](https://webkitgtk.org/) is used to provide webviews on Linux which requires GTK, so if the windowing library doesn't support GTK (as in [`winit`]) you'll need to call [`gtk::init`] before creating the webview and then call [`gtk::main_iteration_do`] alongside your windowing library event loop. ```rust #[derive(Default)] struct App { webview_window: Option<(Window, WebView)>, } impl ApplicationHandler for App { fn resumed(&mut self, event_loop: &ActiveEventLoop) { let window = event_loop.create_window(Window::default_attributes()).unwrap(); let webview = WebViewBuilder::new() .with_url("https://tauri.app") .build(&window) .unwrap(); self.webview_window = Some((window, webview)); } fn window_event(&mut self, _event_loop: &ActiveEventLoop, _window_id: WindowId, event: WindowEvent) {} // Advance GTK event loop <!----- IMPORTANT fn about_to_wait(&mut self, _event_loop: &ActiveEventLoop) { #[cfg(target_os = "linux")] while gtk::events_pending() { gtk::main_iteration_do(false); } } } let event_loop = EventLoop::new().unwrap(); let mut app = App::default(); event_loop.run_app(&mut app).unwrap(); ``` ##### Linux Dependencies ###### Arch Linux / Manjaro: ```bash sudo pacman -S webkit2gtk-4.1 ``` ###### Debian / Ubuntu: ```bash sudo apt install libwebkit2gtk-4.1-dev ``` ###### Fedora ```bash sudo dnf install gtk3-devel webkit2gtk4.1-devel ``` ###### Nix & NixOS ```nix # shell.nix let # Unstable Channel | Rolling Release pkgs = import (fetchTarball("channel:nixpkgs-unstable")) { }; packages = with pkgs; [ pkg-config webkitgtk_4_1 ]; in pkgs.mkShell { buildInputs = packages; } ``` ```sh nix-shell shell.nix ``` ###### GUIX ```scheme ;; manifest.scm (specifications->manifest '("pkg-config" ; Helper tool used when compiling "webkitgtk" ; Web content engine fot GTK+ )) ``` ```bash guix shell -m manifest.scm ``` #### 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: ```bash 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 In order for `wry` to be able to create webviews on Android, there is a few requirements that your application needs to uphold: 1. You need to set a few environment variables that will be used to generate the necessary kotlin files that you need to include in your Android application for wry to function properly. - `WRY_ANDROID_PACKAGE`: which is the reversed domain name of your android project and the app name in snake_case, for example, `com.wry.example.wry_app` - `WRY_ANDROID_LIBRARY`: for example, if your cargo project has a lib name `wry_app`, it will generate `libwry_app.so` so you se this env var to `wry_app` - `WRY_ANDROID_KOTLIN_FILES_OUT_DIR`: for example, `path/to/app/src/main/kotlin/com/wry/example` 2. Your main Android Activity needs to inherit `AppCompatActivity`, preferably it should use the generated `WryActivity` or inherit it. 3. Your Rust app needs to call `wry::android_setup` function to setup the necessary logic to be able to create webviews later on. 4. Your Rust app needs to call `wry::android_binding!` macro to setup the JNI functions that will be called by `WryActivity` and various other places. It is recommended to use [`tao`](https://docs.rs/tao/latest/tao/) crate as it provides maximum compatibility with `wry` ```rust #[cfg(target_os = "android")] { tao::android_binding!( com_example, wry_app, WryActivity, wry::android_setup, // pass the wry::android_setup function to tao which will invoke when the event loop is created _start_app ); wry::android_binding!(com_example, ttt); } ``` If this feels overwhelming, you can just use the preconfigured template from [`cargo-mobile2`](https://github.com/tauri-apps/cargo-mobile2). For more inforamtion, checkout [MOBILE.md](https://github.com/tauri-apps/wry/blob/dev/MOBILE.md). ### Feature flags Wry uses a set of feature flags to toggle several advanced features. - `os-webview` (default): Enables the default WebView framework on the platform. This must be enabled 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 behaviour when there are files interacting with the window. - `x11` (default): Enables x11 support and dependencies on Linux. - `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. - `transparent`: Transparent background on **macOS** requires calling private functions. Avoid this in release build if your app needs to publish to App Store. - `fullscreen`: Fullscreen video and other media on **macOS** requires calling private functions. Avoid this in release build if your app needs to publish to App Store. libraries and prevent from building documentation on doc.rs fails. - `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. ### Partners <table> <tbody> <tr> <td align="center" valign="middle"> <a href="https://crabnebula.dev" target="_blank"> <img src=".github/sponsors/crabnebula.svg" alt="CrabNebula" width="283"> </a> </td> </tr> </tbody> </table> For the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri). ### License Apache-2.0/MIT [`tao`]: https://docs.rs/tao [`winit`]: https://docs.rs/winit [`tracing`]: https://docs.rs/tracing ", Assign "at most 3 tags" to the expected json: {"id":"6966","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"