Struct Input

pub struct Input { /* private fields */ }

The input buffer with cursor support.

Example:

use tui_input::Input;

let input: Input = "Hello World".into();

assert_eq!(input.cursor(), 11);
assert_eq!(input.to_string(), "Hello World");

Implementations

impl Input

pub fn new(value: String) -> Self

Initialize a new instance with a given value Cursor will be set to the given value’s length.

pub fn with_value(self, value: String) -> Self

Set the value manually. Cursor will be set to the given value’s length.

pub fn with_cursor(self, cursor: usize) -> Self

Set the cursor manually. If the input is larger than the value length, it’ll be auto adjusted.

pub fn reset(&mut self)

pub fn value_and_reset(&mut self) -> String

Examples found in repository

examples/ratatui_crossterm_input.rs (line 73)

    fn push_message(&mut self) {
        self.messages.push(self.input.value_and_reset());
    }

pub fn handle(&mut self, req: InputRequest) -> InputResponse

Handle request and emit response.

pub fn value(&self) -> &str

Get a reference to the current value.

Examples found in repository

examples/ratatui_crossterm_input.rs (line 117)

    fn render_input(&self, frame: &mut Frame, area: Rect) {
        // keep 2 for borders and 1 for cursor
        let width = area.width.max(3) - 3;
        let scroll = self.input.visual_scroll(width as usize);
        let style = match self.input_mode {
            InputMode::Normal => Style::default(),
            InputMode::Editing => Color::Yellow.into(),
        };
        let input = Paragraph::new(self.input.value())
            .style(style)
            .scroll((0, scroll as u16))
            .block(Block::bordered().title("Input"));
        frame.render_widget(input, area);

        if self.input_mode == InputMode::Editing {
            // Ratatui hides the cursor unless it's explicitly set. Position the  cursor past the
            // end of the input text and one line down from the border to the input line
            let x = self.input.visual_cursor().max(scroll) - scroll + 1;
            frame.set_cursor_position((area.x + x as u16, area.y + 1))
        }
    }

pub fn cursor(&self) -> usize

Get the currect cursor placement.

pub fn visual_cursor(&self) -> usize

Get the current cursor position with account for multispace characters.

Examples found in repository

examples/ratatui_crossterm_input.rs (line 126)

    fn render_input(&self, frame: &mut Frame, area: Rect) {
        // keep 2 for borders and 1 for cursor
        let width = area.width.max(3) - 3;
        let scroll = self.input.visual_scroll(width as usize);
        let style = match self.input_mode {
            InputMode::Normal => Style::default(),
            InputMode::Editing => Color::Yellow.into(),
        };
        let input = Paragraph::new(self.input.value())
            .style(style)
            .scroll((0, scroll as u16))
            .block(Block::bordered().title("Input"));
        frame.render_widget(input, area);

        if self.input_mode == InputMode::Editing {
            // Ratatui hides the cursor unless it's explicitly set. Position the  cursor past the
            // end of the input text and one line down from the border to the input line
            let x = self.input.visual_cursor().max(scroll) - scroll + 1;
            frame.set_cursor_position((area.x + x as u16, area.y + 1))
        }
    }

pub fn visual_scroll(&self, width: usize) -> usize

Get the scroll position with account for multispace characters.

Examples found in repository

examples/ratatui_crossterm_input.rs (line 112)

    fn render_input(&self, frame: &mut Frame, area: Rect) {
        // keep 2 for borders and 1 for cursor
        let width = area.width.max(3) - 3;
        let scroll = self.input.visual_scroll(width as usize);
        let style = match self.input_mode {
            InputMode::Normal => Style::default(),
            InputMode::Editing => Color::Yellow.into(),
        };
        let input = Paragraph::new(self.input.value())
            .style(style)
            .scroll((0, scroll as u16))
            .block(Block::bordered().title("Input"));
        frame.render_widget(input, area);

        if self.input_mode == InputMode::Editing {
            // Ratatui hides the cursor unless it's explicitly set. Position the  cursor past the
            // end of the input text and one line down from the border to the input line
            let x = self.input.visual_cursor().max(scroll) - scroll + 1;
            frame.set_cursor_position((area.x + x as u16, area.y + 1))
        }
    }

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl Default for Input

fn default() -> Input

Returns the “default value” for a type.

impl Display for Input

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

Formats the value using the given formatter.

impl EventHandler for Input

fn handle_event(&mut self, evt: &CrosstermEvent) -> Option<StateChanged>

Handle crossterm event.

impl From<&str> for Input

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Input> for String

fn from(input: Input) -> Self

Converts to this type from the input type.

impl From<String> for Input

fn from(value: String) -> Self

Converts to this type from the input type.