Struct TextInput

pub struct TextInput<T> {

    pub text: Option<String>,
    pub on_input: Option<Box<dyn FnMut(&mut EventCx<'_, '_>, &mut T, String)>>,
    pub on_submit: Option<Box<dyn FnMut(&mut EventCx<'_, '_>, &mut T, String)>>,
    pub placeholder: String,
    pub multiline: bool,
    pub capitalize: Capitalize,
    pub font_size: Option<f32>,
    pub font_family: Option<FontFamily>,
    pub font_weight: Option<FontWeight>,
    pub font_stretch: Option<FontStretch>,
    pub font_style: Option<FontStyle>,
    pub color: Option<Color>,
    pub placeholder_color: Option<Color>,
    pub align: Option<TextAlign>,
    pub line_height: Option<f32>,
    pub wrap: Option<TextWrap>,
}

A text input.

Can be styled using the TextInputStyle.

Fields

text: Option<String>

The text.

on_input: Option<Box<dyn FnMut(&mut EventCx<'_, '_>, &mut T, String)>>

A callback that is called when an input is received.

on_submit: Option<Box<dyn FnMut(&mut EventCx<'_, '_>, &mut T, String)>>

A callback that is called when the input is submitted.

placeholder: String

Placeholder text to display when the input is empty.

multiline: bool

Whether the input is multi-line.

When disabled (the default), the input will only accept a single line of text.

capitalize: Capitalize

How the text should be capitalized.

This only affects text input from IMEs, eg. on-screen keyboards like the ones on mobile devices.

font_size: Option<f32>

The font size of the text.

font_family: Option<FontFamily>

The font family of the text.

font_weight: Option<FontWeight>

The font weight of the text.

font_stretch: Option<FontStretch>

The font stretch of the text.

font_style: Option<FontStyle>

The font.into of the text.

color: Option<Color>

The color of the text.

placeholder_color: Option<Color>

The color of the placeholder text.

align: Option<TextAlign>

The vertical alignment of the text.

line_height: Option<f32>

The line height of the text.

wrap: Option<TextWrap>

The text wrap of the text.

Implementations

impl<T> TextInput<T>

pub fn placeholder(self, placeholder: impl Into<String>) -> TextInput<T>

Set self.placeholder.

Placeholder text to display when the input is empty.

pub fn multiline(self, multiline: impl Into<bool>) -> TextInput<T>

Set self.multiline.

Whether the input is multi-line.

When disabled (the default), the input will only accept a single line of text.

pub fn capitalize(self, capitalize: impl Into<Capitalize>) -> TextInput<T>

Set self.capitalize.

How the text should be capitalized.

This only affects text input from IMEs, eg. on-screen keyboards like the ones on mobile devices.

pub fn font_size(self, font_size: impl Into<f32>) -> TextInput<T>

Set self.font_size.

The font size of the text.

pub fn font_family(self, font_family: impl Into<FontFamily>) -> TextInput<T>

Set self.font_family.

The font family of the text.

pub fn font_weight(self, font_weight: impl Into<FontWeight>) -> TextInput<T>

Set self.font_weight.

The font weight of the text.

pub fn font_stretch(self, font_stretch: impl Into<FontStretch>) -> TextInput<T>

Set self.font_stretch.

The font stretch of the text.

pub fn font_style(self, font_style: impl Into<FontStyle>) -> TextInput<T>

Set self.font_style.

The font.into of the text.

pub fn color(self, color: impl Into<Color>) -> TextInput<T>

Set self.color.

The color of the text.

pub fn placeholder_color( self, placeholder_color: impl Into<Color>, ) -> TextInput<T>

Set self.placeholder_color.

The color of the placeholder text.

pub fn align(self, align: impl Into<TextAlign>) -> TextInput<T>

Set self.align.

The vertical alignment of the text.

pub fn line_height(self, line_height: impl Into<f32>) -> TextInput<T>

Set self.line_height.

The line height of the text.

pub fn wrap(self, wrap: impl Into<TextWrap>) -> TextInput<T>

Set self.wrap.

The text wrap of the text.

impl<T> TextInput<T>

pub fn new() -> TextInput<T>

Create a new text input view.

pub fn text(self, text: impl ToString) -> TextInput<T>

Set the text of the input.

pub fn on_input( self, on_change: impl FnMut(&mut EventCx<'_, '_>, &mut T, String) + 'static, ) -> TextInput<T>

Set the callback that is called when an input is received.

Note that this doesn’t trigger a rebuild automatically.

pub fn on_submit( self, on_submit: impl FnMut(&mut EventCx<'_, '_>, &mut T, String) + 'static, ) -> TextInput<T>

Set the callback that is called when the input is submitted.

Trait Implementations

impl<T> Default for TextInput<T>

fn default() -> TextInput<T>

Returns the “default value” for a type.

impl<T> Stylable for TextInput<T>

type Style = TextInputStyle

The style type.

fn style( &self, style: &<TextInput<T> as Stylable>::Style, ) -> <TextInput<T> as Stylable>::Style

Style the object.

fn rebuild_style(&self, cx: &mut RebuildCx<'_, '_>, style: &mut Self::Style)

where Self::Style: Rebuild + 'static,

Rebuild the style of the object.

impl<T> View<T> for TextInput<T>

type State = TextInputState

The state of the view, see top-level documentation for more information.

fn build( &mut self, cx: &mut BuildCx<'_, '_>, _data: &mut T, ) -> <TextInput<T> as View<T>>::State

Build the view state, see top-level documentation for more information.

fn rebuild( &mut self, state: &mut <TextInput<T> as View<T>>::State, cx: &mut RebuildCx<'_, '_>, _data: &mut T, _old: &TextInput<T>, )

Rebuild the view state, see top-level documentation for more information.

fn event( &mut self, state: &mut <TextInput<T> as View<T>>::State, cx: &mut EventCx<'_, '_>, data: &mut T, event: &Event, ) -> bool

Handle an event, see top-level documentation for more information.

fn layout( &mut self, state: &mut <TextInput<T> as View<T>>::State, cx: &mut LayoutCx<'_, '_>, _data: &mut T, space: Space, ) -> Size

Layout the view, see top-level documentation for more information.

fn draw( &mut self, state: &mut <TextInput<T> as View<T>>::State, cx: &mut DrawCx<'_, '_>, _data: &mut T, )

Draw the view, see top-level documentation for more information.