Struct iced_web::widget::text_input::TextInput

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

A field that can be filled with text.

Example

enum Message {
    TextInputChanged(String),
}

let mut state = text_input::State::new();
let value = "Some text";

let input = TextInput::new(
    &mut state,
    "This is the placeholder...",
    value,
    Message::TextInputChanged,
);

Implementations

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

pub fn new<F>(
    state: &'a mut State,
    placeholder: &str,
    value: &str,
    on_change: F
) -> Self where
    F: 'static + Fn(String) -> Message, 

Creates a new TextInput.

It expects:

• some State
• a placeholder
• the current value
• a function that produces a message when the TextInput changes

pub fn password(self) -> Self

Converts the TextInput into a secure password input.

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

Sets the width of the TextInput.

pub fn max_width(self, max_width: u32) -> Self

Sets the maximum width of the TextInput.

pub fn padding(self, units: u16) -> Self

Sets the padding of the TextInput.

pub fn size(self, size: u16) -> Self

Sets the text size of the TextInput.

pub fn on_submit(self, message: Message) -> Self

Sets the message that should be produced when the TextInput is focused and the enter key is pressed.

pub fn style(self, style: impl Into<Box<dyn StyleSheet>>) -> Self

Sets the style of the TextInput.

Trait Implementations

impl<'a, Message> From<TextInput<'a, Message>> for Element<'a, Message> where
    Message: 'static + Clone, 

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

Performs the conversion.

impl<'a, Message> Widget<Message> for TextInput<'a, Message> where
    Message: 'static + Clone, 

fn node<'b>(
    &self,
    bump: &'b Bump,
    bus: &Bus<Message>,
    style_sheet: &mut Css<'b>
) -> Node<'b>

Produces a VDOM node for the [Widget].