bevy_webview_wry

[!CAUTION] This crate is in the early stages of development and is subject to breaking changes.

Purpose

The purpose of this crate is integrate bevy and wry using bevy_flurx.

Supported platforms

Setup

Main process(bevy)

Add this to your Cargo.toml:

[dependencies]
bevy_webview_wry = { version = "0.4", features = ["api"] }

# necessary if you want to use ipc-command.
bevy_flurx = "0.11"

Ui process(webview)

Execute the following command in the directory where the package.json is located.

# if you use npm
npm install bevy_flurx_api
# if you use yarn
yarn add bevy_flurx_api
# if you use pnpm
pnpm install bevy_flurx_api

Or, you can also use the API directly from Window.__FLURX__ without installation.

Usage

There are two ways to create a webview:

Converts an existing window into a webview window.

examples/simple.rs

fn spawn_webview(
    mut commands: Commands,
    window: Query<Entity, With<PrimaryWindow>>,
) {
    // Converts the `Window` attached the entity into a webview window. 
    commands
        .entity(window.single())
        .insert(Webview::Uri(WebviewUri::new("https://bevyengine.org/")));
}

Child window

This feature is required child_window feature flag.

Please refer here for supported platforms.

examples/child_window.rs

Embedding Webview in a Window (Experimental)

examples/wry/embedding.rs

Ipc

IpcTrigger

You can listen to messages from the webview as a trigger.

examples/event_listen.rs

Emit event to webview

examples/emit_event_to_webview.rs

IpcCommand

IpcComamnd can be divided into two command patterns: action-command, task-command

Please check examples/ipc_command.rs for details.

ChangeLog

Please see here.

Feature flags

Compatible Bevy versions

License

This crate is licensed under the MIT License or the Apache License 2.0.

Todo

• Support Linux(Wayland)