bevy_extended_ui

Crates.iobevy_extended_ui
lib.rsbevy_extended_ui
version1.2.0
created_at2025-06-02 11:29:06.058156+00
updated_at2026-01-19 11:58:08.391696+00
descriptionCreate simply ui's with css and html for bevy.
homepage
repositoryhttps://github.com/exepta/bevy_extended_ui
max_upload_size
id1697867
size702,763
Exepta (exepta)

documentation

README

bevy_extended_ui

Crates.io Downloads license Build

Since I've been writing a game in the Bevy engine lately, I created this crate. In my game, I need more complex UI elements that Bevy doesn't currently support. These include sliders, choice boxes, check boxes, radio buttons, and so on. So I set about implementing these elements using the standard bevy_ui system. I'd like to make this project available to you so that you can use elements other than just nodes, buttons, or images. If you're missing a widget and know how to create it, it would be great if you could add it. Otherwise, feel free to create a ticket.

Features

There are many features in this crate. You can see all current supported widgets here. Available features:

  • Full HTML support.
  • CSS support but not all CSS properties.
  • Hot reload support.
  • HTML Bind support for interacting with the code.
  • Font support for family and weight.
  • Animation support (@keyframes).
  • Validation for widgets like required fields.
  • Form Widget for validation and submission.
  • Custom Cursor or system cursor support.
  • CSS * support.
  • Customizable theme.

There are many other things, but currently you can use the core (HTML / CSS) features.

How to use?

Add this to your Cargo.toml:

[dependencies]
bevy_extended_ui = "1.2.0"
bevy_extended_ui_macros = "1.2.0"

Then, you add the plugin to your main.rs or on any point at a build function:

fn build(&mut app: App) {
    app.add_plugin(ExtendedUiPlugin);
}

Then you create an HTML file:

<html lang="en">
<head>
    <meta name="test">
    <meta charset="UTF-8">
    <title>Title</title>
    <!-- You can link your CSS file here. -->
    <link rel="stylesheet" href="base.css">
    <!-- <link rel="stylesheet" href="base2.css"> You can add more CSS files.-->
</head>
<body>

<!-- You can use HTML bindings here. like the onclick attribute. -->
<button onclick="test_click">Button</button>

</body>
</html>

And finally,

fn build(&mut app: App) {
    app.add_systems(Startup, |mut reg: ResMut<UiRegistry>, asset_server: Res<AssetServer>| {
        let handle: Handle<HtmlAsset> = asset_server.load("YOUR_ASSETS_LOCATION/test.html");
        reg.add_and_use("test".to_string(), HtmlSource::from_handle(handle));
    });
}

#[html_fn("test_click")]
fn test_click(In(event): In<HtmlEvent>) {
    println!("Button clicked!");
}

Note that currently you can use this binding:

  • onclick
  • onchange Only for <select>, <fieldset>, <input>, <checkbox> and <slider> elements.
  • oninit
  • onmouseover
  • onmouseout

WASM support

Now we have wasm support but still not fully tested! Here is an example to show you how to use it:

fn main() {
    #[cfg(target_arch = "wasm32")]
    console_error_panic_hook::set_once();

    App::new()
        .add_plugins(DefaultPlugins.set(WindowPlugin {
            primary_window: Some(Window {
                title: "Bevy WASM".into(),
                canvas: Some("#bevy".into()),
                fit_canvas_to_parent: true,
                prevent_default_event_handling: true,
                ..default()
            }),
            ..default()
        }).set(AssetPlugin {
            meta_check: AssetMetaCheck::Never,
            ..default()
        }))
        .add_plugins(ExtendedUiPlugin)
        .add_systems(Startup, load_ui)
        .run();
}

fn load_ui(mut reg: ResMut<UiRegistry>, asset_server: Res<AssetServer>) {
    let handle: Handle<HtmlAsset> = asset_server.load("test.html");
    reg.add_and_use("test-ui".to_string(), HtmlSource::from_handle(handle));
}

and the index HTML:

<!doctype html>
<html lang="en">
<head>
    <meta charset="utf-8" />
    <title>Bevy Web</title>
    <style>
        html, body { margin: 0; padding: 0; width: 100%; height: 100%; overflow: hidden; background: #333; }
        #container { width: 100%; height: 100%; }
        canvas { width: 100%; height: 100%; display: block; }
    </style>
    <link data-trunk rel="copy-dir" href="assets" />
</head>
<body>
<div id="container">
    <canvas id="bevy"></canvas>
</div>
</body>
</html>

It was tested with the crate trunk, which worked well. This trunk.toml file was used:

[build]
dist = "dist"

[[copy]]
source = "assets"
dest = "assets"

[serve]
no_spa = true

Animation support

Basic @keyframes usage example:

@keyframes button-pulse {
    0% {
        transform: scale(1);
        background-color: #4c8bf5;
    }
    50% {
        transform: scale(1.05);
        background-color: #72a1ff;
    }
    100% {
        transform: scale(1);
        background-color: #4c8bf5;
    }
}

.cta-button {
    animation: button-pulse 1.4s ease-in-out infinite alternate;
}

You can now use @keyframes in your CSS. There is now a limit tested; this means that you can use any CSS property.

What comes next?

Next, I'd like to build a website that's structured like React documentation. There you'll always be able to see all the patches and how to apply them! If anyone has any ideas, I'd be happy to hear them.

Compatibility

Note: This project is currently under construction and not suitable for large projects!.

Bevy version bevy_extended_ui version
0.18.0 1.2.0
0.17.0 1.0.0 - 1.1.0
0.16.0 0.1.0 - 0.2.2

Important Links

Link to Widget attributes
Link to Patches

Commit count: 336

cargo fmt