Struct Input 

pub struct Input {
    pub states: InputStates,
    /* private fields */
}

Input represents a read-write input field. This component supports different input types, input length and handles input events related to cursor position, backspace, canc, …

Fields

states: InputStates

Implementations

impl Input

pub fn foreground(self, fg: Color) -> Self

Set the main foreground color. This may get overwritten by individual text styles.

pub fn background(self, bg: Color) -> Self

Set the main background color. This may get overwritten by individual text styles.

pub fn modifiers(self, m: TextModifiers) -> Self

Set the main text modifiers. This may get overwritten by individual text styles.

pub fn style(self, style: Style) -> Self

Set the main style. This may get overwritten by individual text styles.

This option will overwrite any previous foreground, background and modifiers!

pub fn inactive(self, s: Style) -> Self

Set a custom style for the border when the component is unfocused.

pub fn borders(self, b: Borders) -> Self

Add a border to the component.

pub fn title<T: Into<Title>>(self, title: T) -> Self

Add a title to the component.

pub fn input_type(self, itype: InputType) -> Self

Set the type of input this Input Component is for. Specific types may have different display or validate methods.

pub fn input_len(self, ilen: usize) -> Self

Set the max length of the input.

pub fn value<S: Into<String>>(self, s: S) -> Self

Set the inital value of the Input.

pub fn invalid_style(self, s: Style) -> Self

Set a style for when the input fails validation.

pub fn placeholder<S: Into<LineStatic>>(self, placeholder: S) -> Self

Set a placeholder text for when the Input is empty.

Trait Implementations

impl Component for Input

fn view(&mut self, render: &mut Frame<'_>, area: Rect)

Based on the current properties and states, renders the component in the provided area frame. Render can also mutate the component state if this is required

fn query<'a>(&'a self, attr: Attribute) -> Option<QueryResult<'a>>

Query attribute of component properties.

fn attr(&mut self, attr: Attribute, value: AttrValue)

Set attribute to properties. query describes the name, while attr the value it’ll take

fn state(&self) -> State

Get current state from component

fn perform(&mut self, cmd: Cmd) -> CmdResult

Perform a command on the component. The command will may change the component state. The method returns the result of the command applied (what changed if any)

impl Default for Input

fn default() -> Input

Returns the “default value” for a type.