bevy_text_edit

A very easy-to-use plugin for input text in Bevy. Good enough for game setting and command console.

Features:

• Switchable between multiple text boxes.
• Moving the text cursor using arrow keys and Home/End.
• Limit input length.
• Filter input text with regex.
• Placeholder.
• Paste with Ctrl+v.
• In-game virtual keyboard.
  • Repeated key.

Not support:

• IME.
• In-game virtual keyboard.
  • Multi-language.
• Select text.
• Copy.

Quickstart

Plugin

Add plugin TextEditPlugin to the app and define which states it will run in:

#[derive(Clone, Debug, Default, Eq, PartialEq, Hash, States)]
enum GameState {
    #[default]
    Menu,
}

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        // Add the plugin
        .add_plugins(TextEditPlugin::new(vec![GameState::Menu]))
        .run;
}

If you don't care to game state and want to always run input text, use TextEditPluginAnyState:

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        // Add the plugin
        .add_plugins(TextEditPluginAnyState::any())
        .add_systems(Startup, setup)
        .run();
}

Component

Insert component TextEditable into any text entity that needs to be editable:

fn setup(mut commands: Commands) {
    commands.spawn((
        TextEditable::default(), // Mark text is editable
        Text::new("Input Text 1"),
    ));
}

Only text focused by clicking gets keyboard input.

It is also possible to limit which characters are allowed to enter through filter_in and filter_out attribute (regex is supported):

fn setup(mut commands: Commands) {
    commands.spawn((
        TextEditable {
            filter_in: vec!["[0-9]".into(), " ".into()], // Only allow number and space
            filter_out: vec!["5".into()],                // Ignore number 5
            ..default()
        },
        Text::new("Input Text 1"),
    ));
}

Get text

The edited text can be retrieved from event or observe trigger TextEdited.

// Get by event
fn get_text(
    mut event: MessageReader<TextEdited>,
) {
    for e in event.read() {
        info!("Entity {}: {}", e.entity, e.text);
    }
}

// Get by observing
fn setup(mut commands: Commands) {
    commands.spawn((
        TextEditable::default(),
        Text::new("Input Text"),
    )).observe(get_text);
}

fn get_text(
    trigger: On<TextEdited>,
) {
    let text = trigger.text.as_str();
    info!("{}", text);
}

License

Please see LICENSE.

Compatible Bevy Versions