Struct TextInput 

pub struct TextInput {
    pub placeholder: String,
    pub cursor: usize,
    pub selection_anchor: Option<usize>,
    pub multiline: bool,
}

Marker: this entity is an editable text input.

• Spawned by the <input> markup tag.
• Gates [lumen_input::type_into_focused]; entities without this marker do not receive typing input even when focused.
• placeholder is shown verbatim while TextContent is empty.
• cursor indexes TextContent in bytes; ArrowLeft / ArrowRight move on Unicode boundaries.

Fields

placeholder: String

Hint text shown when the input is empty.

cursor: usize

Caret byte offset within the entity’s TextContent; clamped to 0..=text.len() by the input router.

selection_anchor: Option<usize>

Selection anchor.

• None: no selection; the cursor alone marks the insertion point.
• Some(a): min(a, cursor)..max(a, cursor) is selected and highlighted.
• Populated by Shift+Arrow / Shift+Home / Shift+End / Ctrl+A; collapsed to None on any non-shifted cursor move.

multiline: bool

Whether bare Enter inserts \n.

• true (e.g. <textarea>): Enter inserts; Shift+Enter still commits.
• false (single-line <input>): Enter commits via crate::input::TextInputCommitted.

Trait Implementations

impl Clone for TextInput

fn clone(&self) -> TextInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for TextInput

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for TextInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TextInput

fn default() -> TextInput

Returns the “default value” for a type.

impl From<&TextInput> for A11yRole

fn from(t: &TextInput) -> Self

Converts to this type from the input type.