Struct TextInput 

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

Text input widget.

Stateful

This widget implements StatefulWidget, you can use it with TextInputState to handle common actions.

Implementations

impl<'a> TextInput<'a>

pub fn new() -> TextInput<'a>

New widget.

pub fn styles_opt(self, styles: Option<TextStyle>) -> TextInput<'a>

Set the combined style.

pub fn styles(self, styles: TextStyle) -> TextInput<'a>

Set the combined style.

pub fn style(self, style: impl Into<Style>) -> TextInput<'a>

Base text style.

pub fn focus_style(self, style: impl Into<Style>) -> TextInput<'a>

Style when focused.

pub fn select_style(self, style: impl Into<Style>) -> TextInput<'a>

Style for selection

pub fn invalid_style(self, style: impl Into<Style>) -> TextInput<'a>

Style for the invalid indicator. This is patched onto either base_style or focus_style

pub fn text_style_idx(self, idx: usize, style: Style) -> TextInput<'a>

Indexed text-style.

Use [TextAreaState::add_style()] to refer a text range to one of these styles.

pub fn text_style<T>(self, styles: T) -> TextInput<'a>

where T: IntoIterator<Item = Style>,

List of text-styles.

Use [TextAreaState::add_style()] to refer a text range to one of these styles.

pub fn text_style_map<T>(self, styles: HashMap<usize, T>) -> TextInput<'a>

where T: Into<Style>,

Map of style_id -> text_style.

Use [TextAreaState::add_style()] to refer a text range to one of these styles.

pub fn block(self, block: Block<'a>) -> TextInput<'a>

Block.

pub fn passwd(self) -> TextInput<'a>

Display as password field.

pub fn on_focus_gained(self, of: TextFocusGained) -> TextInput<'a>

Focus behaviour

pub fn on_focus_lost(self, of: TextFocusLost) -> TextInput<'a>

Focus behaviour

pub fn width(&self) -> u16

Preferred width: 0

pub fn height(&self) -> u16

Preferred height: 1

Trait Implementations

impl<'a> Clone for TextInput<'a>

fn clone(&self) -> TextInput<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TextInput<'a>

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

Formats the value using the given formatter.

impl<'a> Default for TextInput<'a>

fn default() -> TextInput<'a>

Returns the “default value” for a type.

impl<'a> StatefulWidget for &TextInput<'a>

type State = TextInputState

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <&TextInput<'a> as StatefulWidget>::State, )

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

impl StatefulWidget for TextInput<'_>

type State = TextInputState

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <TextInput<'_> as StatefulWidget>::State, )

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.