Struct ReactUiPlugin 

pub struct ReactUiPlugin { /* private fields */ }

Adds a React-driven bevy_ui layer to a Bevy App.

Point it at a built JS bundle (see the bevy-react npm package). The plugin spawns the dedicated JS thread, applies the reconciler’s ops to the ECS, reports interactions back to React, and — unless disabled — hot reloads the app when the bundle changes on disk.

Implementations

impl ReactUiPlugin

pub fn new(bundle: impl Into<PathBuf>) -> Self

Create the plugin for the given built app bundle (app.js). The build emits a vendor.js beside it (react + the bevy-react runtime, loaded once); both must exist. Hot reload (React Fast Refresh — edits preserve component state) and the Reanimated-style animations engine are enabled by default.

The plugin does not spawn a camera — bevy_ui needs one to render, so your app must provide it (a Camera2d, or any camera that renders UI).

pub fn hot_reload(self, yes: bool) -> Self

Enable/disable watching the bundle and hot reloading on change.

pub fn with_animations(self, yes: bool) -> Self

Enable/disable the bundled ReactUiAnimationsPlugin (the Animated.node / shared-value engine). On by default; disable to drop it entirely — the op_animate op stays registered but its commands are discarded.

pub fn default_font(self, path: impl Into<PathBuf>) -> Self

Set the app-wide default font, loaded via the AssetServer (path relative to your AssetPlugin.file_path, e.g. "fonts/Roboto.ttf"). Every <text> run uses it unless its style names another family via Self::font.

pub fn font(self, name: impl Into<String>, path: impl Into<PathBuf>) -> Self

Register a named font family. React selects it per element with style={{ fontFamily: name }}; the path is loaded via the AssetServer (relative to your AssetPlugin.file_path).

pub fn cursor( self, name: impl Into<String>, path: impl Into<PathBuf>, hotspot: (u16, u16), ) -> Self

Register a named custom image cursor. React selects it per element with style={{ cursor: name }} (any name that isn’t a built-in cursor keyword); the image at path is loaded via the AssetServer (relative to your AssetPlugin.file_path), and hotspot is the click-point pixel (top-left origin) within it. The cursor analogue of Self::font.

Trait Implementations

impl Plugin for ReactUiPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.