Minimal unstyled Text Input with Parley by Zeophlite · Pull Request #23282 · bevyengine/bevy

Zeophlite · 2026-03-09T16:26:15Z

Objective

Minimal unstyled Text Input, using Parley, Text Input #23014

Solution

Initial work based off of @alice-i-cecile parley-text-input and @ickshonpe 's text-editing and parley-input branches
EditableText component wraps a parley::PlainEditor
Edits to the text are made via a queue of TextEdit items
We use the PlainEditor for layout, and render from there

Relevant schedules are:

PreUpdate, bevy_ui_widgets::process_text_inputs
PostUpdate, bevy_text::apply_text_edits
PostUpdate, bevy_ui::editable_text_system

And in render_app:

ExtractSchedule, bevy_ui_render::extract_text_editable
ExtractSchedule, bevy_ui_render::extract_text_cursor

Testing

cargo run --example editable_text

Showcase

crates/bevy_text/src/pipeline.rs

crates/bevy_text/src/text_editable.rs

crates/bevy_ui/src/widget/text.rs

crates/bevy_ui_render/src/cursor.rs

examples/ui/text/editable_text.rs

github-actions · 2026-03-09T16:57:48Z

The generated examples/README.md is out of sync with the example metadata in Cargo.toml or the example readme template. Please run cargo run -p build-templated-pages -- update examples to update it, and commit the file change.

CI docfixs docs

.github/actions/install-linux-deps/action.yml

examples/ui/text/editable_text.rs

crates/bevy_ui/src/widget/text_editable.rs

crates/bevy_ui/src/widget/text.rs

crates/bevy_text/src/cursor.rs

alice-i-cecile

Getting close! I've spotted a few issues during review, but I'm really pleased with the progress here.

IMO one more round of fixes and we should be good to merge.

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

examples/ui/text/editable_text.rs

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

ickshonpe · 2026-03-13T13:03:35Z

crates/bevy_ui_render/src/cursor.rs

@@ -0,0 +1,118 @@
+use bevy_asset::AssetId;


Feels excessive to add a module just for cursor rendering. If we do this, it would make more sense to rename it to text and move all text extraction into it.

ickshonpe · 2026-03-17T12:16:34Z

crates/bevy_ui/src/widget/text_editable.rs

+                                let mut scaler = scale_cx
+                                    .builder(font_ref)
+                                    .size(font_size)
+                                    .hint(true)


Suggested change

.hint(true)

.hint(matches!(hinting, FontHinting::Enabled))

And made a quick PR to change should_hint to pub: #23397

ickshonpe · 2026-03-17T12:25:04Z

crates/bevy_ui/src/widget/text_editable.rs

+        let logical_viewport_size = target.logical_size();
+        let font_size = text_font.font_size.eval(logical_viewport_size, rem_size.0);
+        style_set.insert(parley::StyleProperty::FontSize(font_size));
+


Suggested change

style_set.insert(parley::StyleProperty::Brush(TextBrush::new(

0,

text_font.font_smoothing,

)));

ickshonpe · 2026-03-17T12:58:47Z

crates/bevy_text/src/text_editable.rs

+    /// Text edit actions that have been requested but not yet applied.
+    ///
+    /// These edits are processed in first-in, first-out order.
+    pub pending_edits: VecDeque<TextEdit>,


I think the edits buffer should probably be managed by the widget implementation, otherwise there might be synchronisation issues with non-editing actions like submit and insert/overwrite mode switching.

ickshonpe · 2026-03-17T13:02:14Z

crates/bevy_text/src/text_editable.rs

+    /// Text edit actions that have been requested but not yet applied.
+    ///
+    /// These edits are processed in first-in, first-out order.
+    pub pending_edits: VecDeque<TextEdit>,


Is there a reason for using a VecDeque? If all the edits are always applied, it can just be drained.

ickshonpe · 2026-03-17T13:12:43Z

crates/bevy_text/src/text_editable.rs

+        // Take the `pending_edits` out of the struct so we can apply them without mutable aliasing issues.
+        // We do not need to put the `pending_edits` back into the struct,
+        // as all edits should be consumed by this method, leaving `pending_edits` empty at the end.
+        let mut pending_edits = core::mem::take(&mut self.pending_edits);
+        let mut driver = self.editor_mut().driver(font_context, layout_context);
+
+        while let Some(edit) = pending_edits.pop_front() {
+            driver = apply_edit(edit, driver);
+        }


Suggested change

// Take the `pending_edits` out of the struct so we can apply them without mutable aliasing issues.

// We do not need to put the `pending_edits` back into the struct,

// as all edits should be consumed by this method, leaving `pending_edits` empty at the end.

let mut pending_edits = core::mem::take(&mut self.pending_edits);

let mut driver = self.editor_mut().driver(font_context, layout_context);

while let Some(edit) = pending_edits.pop_front() {

driver = apply_edit(edit, driver);

}

let Self {

editor,

pending_edits,

..

} = self;

let mut driver = editor.driver(font_context, layout_context);

for edit in pending_edits.drain(..) {

driver = apply_edit(edit, driver);

}

ickshonpe · 2026-03-17T13:34:13Z

crates/bevy_text/src/text_editable.rs

+    /// Cursor width, relative to font size
+    pub cursor_width: f32,


Cursor width options should be in a separate CursorStyle/Shape/Size component I think.

ickshonpe · 2026-03-17T14:06:13Z

crates/bevy_ui/src/widget/text_editable.rs

+                            font_size_bits: font_size.to_bits(),
+                            variations_hash: FixedHasher.hash_one(coords),
+                            hinting: *hinting,
+                            font_smoothing: brush.font_smoothing,


Brush needs to be set, otherwise this always uses the default smoothing setting.

ickshonpe · 2026-03-17T14:10:53Z

crates/bevy_ui_render/src/lib.rs

    pub const TEXT: f32 = 0.06;
+    pub const TEXT_CURSOR: f32 = 0.065;
    pub const TEXT_STRIKETHROUGH: f32 = 0.07;
+    pub const TEXT_SELECTION: f32 = 0.08;


Text selection rects should be drawn behind the text and cursor.

Suggested change

pub const TEXT_SELECTION: f32 = 0.08;

pub const TEXT_SELECTION: f32 = 0.055;

Oh I see you set it transparent atm, it should be behind the cursor at least though.

ickshonpe · 2026-03-17T14:47:19Z

crates/bevy_ui_widgets/src/lib.rs

            .add(RadioGroupPlugin)
            .add(ScrollbarPlugin)
            .add(SliderPlugin)
+            .add(EditableTextInputPlugin)


Adding UiWidgetsPlugin will panic if you don't add InputDispatchPlugin as process_text_inputs uses Res<InputFocus>.

ickshonpe · 2026-03-17T14:59:35Z

crates/bevy_ui_render/src/lib.rs

    }
 }

+pub fn extract_text_editable(


The EditableText entity has all the necessary components so the text is already rendered by extract_text_system, this system just queues the glyphs to be drawn a second time.

ickshonpe · 2026-03-17T16:20:11Z

crates/bevy_ui_render/src/cursor.rs

+    ) in text_node_query.iter()
+    {
+        // Skip if not visible
+        // Note that `uinode.is_empty()` may be empty when there is no text, but we still want to display the cursor


There should be a uinode.is_empty() check here. In general the size of the node shouldn't depend on the size of the text layout.

ickshonpe · 2026-03-17T16:22:15Z

crates/bevy_ui/src/widget/text_editable.rs

+        content_size.set(NodeMeasure::Fixed(FixedMeasure {
+            size: info.size * target.scale_factor(),
+        }));


Shouldn't add a measure func, the EditableText node should just be set to fill its parent. That is is unless it's using a fixed height based on the number of lines and/or a fixed width based on a max number of glyphs.

Suggested change

content_size.set(NodeMeasure::Fixed(FixedMeasure {

size: info.size * target.scale_factor(),

}));

ickshonpe · 2026-03-17T16:33:36Z

crates/bevy_ui/src/widget/text_editable.rs

+        info.glyphs.clear();
+        info.run_geometry.clear();
+
+        for line in layout.lines() {


Should just call TextPipeline::update_text_layout_info here.

ickshonpe · 2026-03-17T16:41:29Z

examples/ui/text/editable_text.rs

+                width: px(200),
+                height: px(100),


Set the size on the EditableText node itself, then don't have to bother with the measure func.

Suggested change

width: px(200),

height: px(100),

ickshonpe · 2026-03-17T16:42:49Z

examples/ui/text/editable_text.rs

+        .id();
+
+    let edit = commands
+        .spawn((


Suggested change

.spawn((

.spawn((

Node {

width: px(200),

height: px(100),

..Default::default()

},

ickshonpe · 2026-03-17T17:27:40Z

crates/bevy_text/src/text_editable.rs

+/// and provides methods for applying text edits and cursor movements correctly
+/// according to Unicode rules.
+#[derive(Component)]
+#[require(TextLayout, TextFont, TextColor, LineHeight, FontHinting)]


I feel like EditableText should just be newtype around PlainEditor and not have any requirements. Maybe no helper functions even.

IMO the basic design should instead use a primary TextInput (or whatever) component that newtypes a string and require's everything. Then the widget's update system keeps the TextInput component synchronised with the PlainEditor's text buffer, for seamless change detection. So users can modify the TextInput's String to update the PlainEditors text buffer and they can use change detection on TextInput to watch for any changes due to edits on the PlainEditor. We can just clone the strings, it doesn't matter as only one input will be active at a time and we aren't building a text editor for giant text files.

ickshonpe · 2026-03-17T17:50:54Z

crates/bevy_ui_widgets/src/editable_text.rs

+///
+/// Note that this does not immediately apply the edits; they are queued up in [`EditableText::pending_edits`],
+/// and then applied later by the [`apply_text_edits`](`bevy_text::apply_text_edits`) system.
+pub fn process_text_inputs(


This should be an observer watching for On<FocusedInput<KeyboardInput> I guess. It's more idiomatic and an observer can propagate unhandled keystrokes if needed.

Agreed: any keystrokes that are not handled by the text input widget should be allowed to propagate. This lets things like "Ctrl-W to close window" work.

ickshonpe · 2026-03-17T19:09:03Z

crates/bevy_ui_widgets/src/editable_text.rs

+        app.register_required_components::<EditableText, Node>()
+            .register_required_components::<EditableText, TextNodeFlags>()
+            .register_required_components::<EditableText, ContentSize>();


The primary component should be in this module, then there's no need to bother with this.

ickshonpe · 2026-03-17T22:43:04Z

crates/bevy_ui/src/lib.rs

                .ambiguous_with(bevy_sprite::update_text2d_layout)
                .ambiguous_with(bevy_sprite::calculate_bounds_text2d),
+            widget::editable_text_system
+                .in_set(UiSystems::PostLayout)


This is incorrect atm, measure funcs should be updated before UiSystems::Layout. Will need to be split up into two systems as it is for UI text, one in UiSystems::Content and one in UiSystems::PostLayout.

ickshonpe · 2026-03-17T22:51:55Z

crates/bevy_ui/src/widget/text_editable.rs

+        content_size.set(NodeMeasure::Fixed(FixedMeasure {
+            size: info.size * target.scale_factor(),
+        }));


Another problem here is that most edits are going to change the size of the text layout, so the measure func will be updated which will cause an unnecessary relayout of the node.

alice-i-cecile and others added 9 commits March 7, 2026 10:22

Initial port to parley

2edb3b2

Added TextCursorStyle component.

2a0db90

Added cursor and selection rects to TextLayoutInfo

3853701

Added cursor and selection rects rendering

ec07639

Move cursor rendering to own file

0057f73

editable_text.rs -> text_editable.rs

8b45b19

Move TextEdit to own file

e7a44e5

Move editing.rs to cursor.rs

ebc1d61

WIP Input Text

04c411b

Zeophlite commented Mar 9, 2026

View reviewed changes

crates/bevy_text/src/pipeline.rs Outdated Show resolved Hide resolved

Zeophlite commented Mar 9, 2026

View reviewed changes

crates/bevy_text/src/text_editable.rs Outdated Show resolved Hide resolved

Zeophlite commented Mar 9, 2026

View reviewed changes

crates/bevy_text/src/text_editable.rs Outdated Show resolved Hide resolved

Zeophlite commented Mar 9, 2026

View reviewed changes

crates/bevy_text/src/text_editable.rs Outdated Show resolved Hide resolved

Zeophlite commented Mar 9, 2026

View reviewed changes

crates/bevy_text/src/text_editable.rs Outdated Show resolved Hide resolved

Zeophlite commented Mar 9, 2026

View reviewed changes

crates/bevy_ui/src/widget/text.rs Outdated Show resolved Hide resolved

Zeophlite commented Mar 9, 2026

View reviewed changes

crates/bevy_ui_render/src/cursor.rs Outdated Show resolved Hide resolved

Zeophlite commented Mar 9, 2026

View reviewed changes

examples/ui/text/editable_text.rs Show resolved Hide resolved

IQuick143 added A-Text Rendering and layout for characters D-Modest A "normal" level of difficulty; suitable for simple features or challenging fixes A-UI Graphical user interfaces, styles, layouts, and widgets labels Mar 9, 2026

github-project-automation bot added this to UI Mar 9, 2026

github-project-automation bot moved this to Needs SME Triage in UI Mar 9, 2026

CI

8e06897

CI docfixs docs

Zeophlite force-pushed the parley-text-input2 branch from 9a88110 to 8e06897 Compare March 9, 2026 17:27

Zeophlite commented Mar 9, 2026

View reviewed changes

.github/actions/install-linux-deps/action.yml Outdated Show resolved Hide resolved

CI

0a4c802

Zeophlite force-pushed the parley-text-input2 branch from 8567f0a to 0a4c802 Compare March 9, 2026 18:14

alice-i-cecile added M-Release-Note Work that should be called out in the blog due to impact S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Mar 9, 2026

alice-i-cecile reviewed Mar 16, 2026

View reviewed changes

examples/ui/text/editable_text.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Mar 16, 2026

View reviewed changes

examples/ui/text/editable_text.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Mar 16, 2026

View reviewed changes

crates/bevy_ui/src/widget/text_editable.rs Show resolved Hide resolved

alice-i-cecile reviewed Mar 16, 2026

View reviewed changes

crates/bevy_ui/src/widget/text.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Mar 16, 2026

View reviewed changes

crates/bevy_text/src/cursor.rs Show resolved Hide resolved

alice-i-cecile requested changes Mar 16, 2026

View reviewed changes

alice-i-cecile added S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Mar 16, 2026

Zeophlite and others added 4 commits March 17, 2026 08:02

Apply suggestions from code review

09eed51

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

Review

c1449b4

Merge remote-tracking branch 'origin/main' into parley-text-input2

6cc5689

Use TextBrush now

c59943d

Zeophlite added S-Needs-Review Needs reviewer attention (from anyone!) to move forward and removed S-Waiting-on-Author The author needs to make changes or address concerns before this can be merged labels Mar 17, 2026

cat walked over my keyboard

49d7294

alice-i-cecile reviewed Mar 17, 2026

View reviewed changes

examples/ui/text/editable_text.rs Outdated Show resolved Hide resolved

Fix outdated instructions in example

dd060e6

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

alice-i-cecile approved these changes Mar 17, 2026

View reviewed changes

alice-i-cecile added this to the 0.19 milestone Mar 17, 2026

ickshonpe reviewed Mar 17, 2026

View reviewed changes

+        style_set.insert(parley::StyleProperty::Brush(TextBrush::new(
+,
+            text_font.font_smoothing,
+        )));

		/// Cursor width, relative to font size
		pub cursor_width: f32,

	pub const TEXT_SELECTION: f32 = 0.08;
	pub const TEXT_SELECTION: f32 = 0.055;

	content_size.set(NodeMeasure::Fixed(FixedMeasure {
	size: info.size * target.scale_factor(),
	}));

Uh oh!

Conversation

Zeophlite commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Objective

Solution

Testing

Showcase

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 9, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ickshonpe Mar 13, 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!

Choose a reason for hiding this comment

Uh oh!

ickshonpe Mar 17, 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 Mar 17, 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!

ickshonpe Mar 17, 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!

ickshonpe Mar 17, 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

Zeophlite commented Mar 9, 2026 •

edited

Loading

ickshonpe Mar 13, 2026 •

edited

Loading

ickshonpe Mar 17, 2026 •

edited

Loading

ickshonpe Mar 17, 2026 •

edited

Loading

ickshonpe Mar 17, 2026 •

edited

Loading

ickshonpe Mar 17, 2026 •

edited

Loading

ickshonpe Mar 17, 2026 •

edited

Loading