TextInput by viridia · Pull Request #24929 · bevyengine/bevy

viridia · 2026-07-09T15:47:12Z

This PR splits the functionality of the EditableText component into two separate components: EditableText (which lives in bevy_text) and TextInput (which lives in bevy_ui_widgets).

See release notes for more details.

* FeathersLazyMenu * FeathersMenuToolButton

ickshonpe · 2026-07-10T10:11:21Z

+pub enum TextInput {
+    /// Text input functions normally
+    #[default]
+    Editable,
+    /// Cursor movement, selection, and copy to clipboard is still enabled, but no mutations are allowed
+    ReadOnly,
+    /// Display only, all interactions disabled - this is used by number input widget when dragging.
+    DisplayOnly,
+}


I don't like the variant names either. Not sure I have any better suggestions though, probably not worth fussing about.

ickshonpe · 2026-07-10T10:18:24Z

+#[require(EditableText)]
+#[require(AccessibilityNode(accesskit::Node::new(Role::TextInput)))]
+#[reflect(Component)]
+pub enum TextInput {


I think this should be called something like TextInputMode or TextInputInteractionState. The name TextInput suggests that this is the primary text input component. But it's not part of the user-facing API, it's used for tracking the input's interaction state internally.

OK so here's the problem I have: this component does more than just control the readonly mode - it also pulls in the AccessibilityNode required component. If I were to rename this to ReadWriteMode as we discussed, then this required component doesn't make sense, and I'd have to move it to EditableText. But I'm not sure if bevy_text should be pulling in accessibility - it depends on whether you consider EditableText to be a widget, or just a buffer.

Worse, if this truly is just a mode switch and not a "widget" then it probably should be optional, which means I definitely can't put the accessibility node required component here.

ickshonpe · 2026-07-10T11:25:11Z


-    let mut queue_edit = |edit| {
-        if keyboard_input.input.state.is_pressed() {
+    let mut queue_edit = |edit, readonly| {


The readonly param feels a bit error prone. It'd be clearer with two functions queue_edit and queue_read_only or something but it'd need to use a RefCell or macro.

Maybe we could have a separate function that returns true if a TextEdit is destructive that we can filter by in queue_edit?

ickshonpe

Seems fine, agree with the overall direction. I think maybe instead of the bool param on queue_edit, we could implement an is_destructive method for TextEdit that returns true for destructive TextEdit s.

Also I haven't thought it through properly but possibly there could be problems with IME if the widget is changed to readonly during composition? I'm not sure we should worry too much though.

ickshonpe · 2026-07-10T13:03:07Z

+        if *text_input == TextInput::Editable
+            || (readonly && *text_input == TextInput::ReadOnly)
+                && keyboard_input.input.state.is_pressed()
+        {


It doesn't check is_pressed in TextInput::Editable mode. It doesn't double enter characters because the

if let Some(text) = &keyboard_input.input.text

guard fails, but everything else like cursor and delete inputs are applied on release as well as press now.

Suggested change

if *text_input == TextInput::Editable

|| (readonly && *text_input == TextInput::ReadOnly)

&& keyboard_input.input.state.is_pressed()

{

if keyboard_input.input.state.is_pressed()

&& (*text_input == TextInput::Editable

|| (readonly && *text_input == TextInput::ReadOnly))

{

ickshonpe · 2026-07-10T13:05:21Z

-        (COMMAND, Key::Character(c)) if c.eq_ignore_ascii_case("x") => queue_edit(TextEdit::Cut),
        (COMMAND, Key::Character(c)) if c.eq_ignore_ascii_case("v") => {
-            queue_edit(TextEdit::Paste);
+            queue_edit(TextEdit::Paste, true);


Suggested change

queue_edit(TextEdit::Paste, true);

queue_edit(TextEdit::Paste, false);

ickshonpe · 2026-07-10T13:11:19Z


+    if *text_input != TextInput::Editable {
+        return;
+    }


Need to the drain IME reader the same as with the other guards.

Suggested change

}

if *text_input != TextInput::Editable {

// Still need to drain the reader to prevent stale events on next focus.

ime_reader.read().for_each(drop);

return;

}

Maybe it would be more robust if we consolidated the three guards and just drain one time.

I thought about this, but even though they have the same effect, the comments in the blocks are different.

ickshonpe · 2026-07-10T13:20:07Z

        return;
    };

+    if *text_input == TextInput::DisplayOnly {


Suggested change

if *text_input == TextInput::DisplayOnly {

if *text_input != TextInput::Editable {

ickshonpe · 2026-07-10T13:44:34Z

 /// System that enables or disables IME on the primary window based on whether the focused entity
 /// is an [`EditableText`].
 ///
 /// IME is enabled when an `EditableText` gains focus and disabled when focus moves elsewhere.


Needs to be updated to add that IME state also depends on TextInput now.

ickshonpe · 2026-07-10T13:51:42Z

+    mut editable_text_query: Query<&mut EditableText, With<TextInput>>,
+) {
    if let Ok(mut editable_text) = editable_text_query.get_mut(trigger.entity) {
        editable_text.queue_edit(TextEdit::clear_ime_compose());


We also need to queue TextEdit::clear_ime_compose() somewhere when TextInput changes away from Editable.

Edit: Added it to the suggested changes for listen_for_ime_input_when_text_input_focused.

ickshonpe · 2026-07-10T13:54:53Z

+    #[default]
+    Editable,
+    /// Cursor movement, selection, and copy to clipboard is still enabled, but no mutations are allowed
+    ReadOnly,


Maybe:

Suggested change

ReadOnly,

NavigableOnly,

One reason for preferring ReadOnly is that it's consistent with the behavior of the HTML readonly attribute: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/readonly

ickshonpe · 2026-07-10T13:55:57Z

+    /// Cursor movement, selection, and copy to clipboard is still enabled, but no mutations are allowed
+    ReadOnly,
+    /// Display only, all interactions disabled - this is used by number input widget when dragging.
+    DisplayOnly,


Then this could be NonInteractable or something.

I also thought about Static

Co-authored-by: ickshonpe <david.curthoys@googlemail.com>

viridia added 5 commits June 27, 2026 15:28

New menu-related widgets:

ef2f0ca

* FeathersLazyMenu * FeathersMenuToolButton

PR #

ab47f95

Separate EditableText into two components.

9e03953

Merge remote-tracking branch 'upstream/main' into text_input

046078e

Remove duplicative plugin in examples.

a3dca2e

viridia requested a review from ickshonpe July 9, 2026 16:20

ickshonpe reviewed Jul 10, 2026

View reviewed changes

ickshonpe suggested changes Jul 10, 2026

View reviewed changes

viridia added 2 commits July 11, 2026 09:19

Review feedback (part 1).

6dc4774

Restore original formatting.

3d448c0

viridia force-pushed the text_input branch from 19ec457 to 3d448c0 Compare July 11, 2026 16:23

viridia and others added 3 commits July 11, 2026 09:26

Apply suggestions from code review

577ad78

Co-authored-by: ickshonpe <david.curthoys@googlemail.com>

Merge error.

f68c124

Missing import.

0c9d29e

	queue_edit(TextEdit::Paste, true);
	queue_edit(TextEdit::Paste, false);

-    }
+    if *text_input != TextInput::Editable {
+        // Still need to drain the reader to prevent stale events on next focus.
+        ime_reader.read().for_each(drop);
+        return;
+    }

	if *text_input == TextInput::DisplayOnly {
	if *text_input != TextInput::Editable {

Uh oh!

Uh oh!

Conversation

viridia commented Jul 9, 2026

Uh oh!

ickshonpe Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ickshonpe left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ickshonpe Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ickshonpe Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ickshonpe Jul 10, 2026 •

edited

Loading

ickshonpe left a comment •

edited

Loading

ickshonpe Jul 10, 2026 •

edited

Loading

ickshonpe Jul 10, 2026 •

edited

Loading