Struct TextInput

pub struct TextInput<'a, Message> { /* private fields */ }

A field that can be filled with text.

Implementations

impl<'a, Message> TextInput<'a, Message>

where Message: Clone + 'static,

pub fn new( placeholder: impl Into<Cow<'a, str>>, value: impl Into<Cow<'a, str>>, ) -> Self

Creates a new TextInput.

It expects:

• a placeholder,
• the current value

pub const fn always_active(self) -> Self

Sets the input to be always active. This makes it behave as if it was always focused.

pub fn label(self, label: impl Into<Cow<'a, str>>) -> Self

Sets the text of the TextInput.

pub fn helper_text(self, helper_text: impl Into<Cow<'a, str>>) -> Self

Sets the helper text of the TextInput.

pub fn id(self, id: Id) -> Self

Sets the Id of the TextInput.

pub fn error(self, error: impl Into<Cow<'a, str>>) -> Self

Sets the error message of the TextInput.

pub fn line_height(self, line_height: impl Into<LineHeight>) -> Self

Sets the [LineHeight] of the TextInput.

pub const fn password(self) -> Self

Converts the TextInput into a secure password input.

pub const fn editing(self, enable: bool) -> Self

pub const fn select_on_focus(self, select_on_focus: bool) -> Self

Selects all text when the text input is focused

pub fn on_focus(self, on_focus: Message) -> Self

Emits a message when an unfocused text input has been focused by click.

This will not trigger if the input was focused externally by the application.

pub fn on_unfocus(self, on_unfocus: Message) -> Self

Emits a message when a focused text input has been unfocused via the Tab or Esc key.

This will not trigger if the input was unfocused externally by the application.

pub fn on_input(self, callback: impl Fn(String) -> Message + 'a) -> Self

Sets the message that should be produced when some text is typed into the TextInput.

If this method is not called, the TextInput will be disabled.

pub fn on_submit(self, callback: impl Fn(String) -> Message + 'a) -> Self

Emits a message when a focused text input receives the Enter/Return key.

pub fn on_submit_maybe( self, callback: Option<impl Fn(String) -> Message + 'a>, ) -> Self

Optionally emits a message when a focused text input receives the Enter/Return key.

pub fn on_tab(self, on_tab: Message) -> Self

Emits a message when the Tab key has been captured, which prevents focus from changing.

If you do no want to capture the Tab key, use TextInput::on_unfocus instead.

pub fn on_toggle_edit(self, callback: impl Fn(bool) -> Message + 'a) -> Self

Emits a message when the editable state of the input changes.

pub fn on_paste(self, on_paste: impl Fn(String) -> Message + 'a) -> Self

Sets the message that should be produced when some text is pasted into the TextInput.

pub const fn font(self, font: <Renderer as Renderer>::Font) -> Self

Sets the Font of the TextInput.

pub fn leading_icon(self, icon: Element<'a, Message, Theme, Renderer>) -> Self

Sets the start [Icon] of the TextInput.

pub fn trailing_icon(self, icon: Element<'a, Message, Theme, Renderer>) -> Self

Sets the end [Icon] of the TextInput.

pub fn width(self, width: impl Into<Length>) -> Self

Sets the width of the TextInput.

pub fn padding(self, padding: impl Into<Padding>) -> Self

Sets the Padding of the TextInput.

pub fn size(self, size: impl Into<Pixels>) -> Self

Sets the text size of the TextInput.

pub fn style(self, style: impl Into<<Theme as StyleSheet>::Style>) -> Self

Sets the style of the TextInput.

pub const fn manage_value(self, manage_value: bool) -> Self

Sets the text input to manage its input value or not

pub fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, layout: Layout<'_>, cursor_position: Cursor, value: Option<&Value>, style: &Style, )

Draws the TextInput with the given Renderer, overriding its Value if provided.

pub const fn surface_ids(self, window_id: (Id, Id)) -> Self

Sets the window id of the TextInput and the window id of the drag icon. Both ids are required to be unique. This is required for the dnd to work.

pub const fn dnd_icon(self, dnd_icon: bool) -> Self

Sets the mode of this TextInput to be a drag and drop icon.

pub fn on_clear(self, on_clear: Message) -> Self

pub fn drag_threshold(self, drag_threshold: f32) -> Self

Set the drag threshold.

Trait Implementations

impl<'a, Message> From<TextInput<'a, Message>> for Element<'a, Message, Theme, Renderer>

where Message: 'static + Clone,

fn from( text_input: TextInput<'a, Message>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<Message> Widget<Message, Theme, Renderer> for TextInput<'_, Message>

where Message: Clone + 'static,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn diff(&mut self, tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn operate( &self, tree: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, operation: &mut dyn Operation<()>, )

Applies an Operation to the Widget.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor_position: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, ) -> Status

Processes a runtime Event.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, style: &Style, layout: Layout<'_>, cursor_position: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn mouse_interaction( &self, state: &Tree, layout: Layout<'_>, cursor_position: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, id: Id)

Sets the id of the widget This may be called while diffing the widget tree

fn drag_destinations( &self, _state: &Tree, layout: Layout<'_>, _renderer: &Renderer, dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn a11y_nodes( &self, _layout: Layout<'_>, _state: &Tree, _cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children