Struct Textbox

pub struct Textbox { /* private fields */ }

Implementations

impl Textbox

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

Defines background color of textbox

Examples found in repository

examples/demo.rs (line 40)

    pub fn ui(&mut self, f: &mut Frame) {
        let size = f.area();

        let vertical_chunks = Layout::default()
            .direction(Direction::Vertical)
            .constraints([Constraint::Length(3), Constraint::Length(3), Constraint::Percentage(100)])
            .split(size);

        let block1 = Block::default().borders(Borders::ALL).title(format!("Use <TAB> to switch active textbox, <ESC> to exit demo"));
        f.render_widget(block1, vertical_chunks[0]);

        let textbox = Textbox::default()
            .render_cursor(self.focused_textbox == 0);
        let textbox_rect = Rect {
            x: 1,
            y: 1,
            width: 15,
            height: 1,
        };
        f.render_stateful_widget(textbox, textbox_rect, &mut self.textbox_state);

        let block2 = Block::default().borders(Borders::ALL);
        f.render_widget(block2, vertical_chunks[1]);

        let textbox2 = Textbox::default()
            .fg(ratatui::style::Color::Yellow)
            .bg(ratatui::style::Color::Green)
            .hint_color(ratatui::style::Color::LightGreen)
            .cursor_color(ratatui::style::Color::DarkGray)
            .render_cursor(self.focused_textbox == 1);
        f.render_stateful_widget(textbox2, vertical_chunks[1].inner(ratatui::layout::Margin::new(1, 1)), &mut self.textbox2_state);
    }

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

Defines foreground color (text color) of textbox

Examples found in repository

examples/demo.rs (line 39)

    pub fn ui(&mut self, f: &mut Frame) {
        let size = f.area();

        let vertical_chunks = Layout::default()
            .direction(Direction::Vertical)
            .constraints([Constraint::Length(3), Constraint::Length(3), Constraint::Percentage(100)])
            .split(size);

        let block1 = Block::default().borders(Borders::ALL).title(format!("Use <TAB> to switch active textbox, <ESC> to exit demo"));
        f.render_widget(block1, vertical_chunks[0]);

        let textbox = Textbox::default()
            .render_cursor(self.focused_textbox == 0);
        let textbox_rect = Rect {
            x: 1,
            y: 1,
            width: 15,
            height: 1,
        };
        f.render_stateful_widget(textbox, textbox_rect, &mut self.textbox_state);

        let block2 = Block::default().borders(Borders::ALL);
        f.render_widget(block2, vertical_chunks[1]);

        let textbox2 = Textbox::default()
            .fg(ratatui::style::Color::Yellow)
            .bg(ratatui::style::Color::Green)
            .hint_color(ratatui::style::Color::LightGreen)
            .cursor_color(ratatui::style::Color::DarkGray)
            .render_cursor(self.focused_textbox == 1);
        f.render_stateful_widget(textbox2, vertical_chunks[1].inner(ratatui::layout::Margin::new(1, 1)), &mut self.textbox2_state);
    }

pub fn hint_color(self, hint: Color) -> Self

Defines the color of hint_text

Examples found in repository

examples/demo.rs (line 41)

    pub fn ui(&mut self, f: &mut Frame) {
        let size = f.area();

        let vertical_chunks = Layout::default()
            .direction(Direction::Vertical)
            .constraints([Constraint::Length(3), Constraint::Length(3), Constraint::Percentage(100)])
            .split(size);

        let block1 = Block::default().borders(Borders::ALL).title(format!("Use <TAB> to switch active textbox, <ESC> to exit demo"));
        f.render_widget(block1, vertical_chunks[0]);

        let textbox = Textbox::default()
            .render_cursor(self.focused_textbox == 0);
        let textbox_rect = Rect {
            x: 1,
            y: 1,
            width: 15,
            height: 1,
        };
        f.render_stateful_widget(textbox, textbox_rect, &mut self.textbox_state);

        let block2 = Block::default().borders(Borders::ALL);
        f.render_widget(block2, vertical_chunks[1]);

        let textbox2 = Textbox::default()
            .fg(ratatui::style::Color::Yellow)
            .bg(ratatui::style::Color::Green)
            .hint_color(ratatui::style::Color::LightGreen)
            .cursor_color(ratatui::style::Color::DarkGray)
            .render_cursor(self.focused_textbox == 1);
        f.render_stateful_widget(textbox2, vertical_chunks[1].inner(ratatui::layout::Margin::new(1, 1)), &mut self.textbox2_state);
    }

pub fn cursor_color(self, cursor: Color) -> Self

Defines the color of cursor

Examples found in repository

examples/demo.rs (line 42)

    pub fn ui(&mut self, f: &mut Frame) {
        let size = f.area();

        let vertical_chunks = Layout::default()
            .direction(Direction::Vertical)
            .constraints([Constraint::Length(3), Constraint::Length(3), Constraint::Percentage(100)])
            .split(size);

        let block1 = Block::default().borders(Borders::ALL).title(format!("Use <TAB> to switch active textbox, <ESC> to exit demo"));
        f.render_widget(block1, vertical_chunks[0]);

        let textbox = Textbox::default()
            .render_cursor(self.focused_textbox == 0);
        let textbox_rect = Rect {
            x: 1,
            y: 1,
            width: 15,
            height: 1,
        };
        f.render_stateful_widget(textbox, textbox_rect, &mut self.textbox_state);

        let block2 = Block::default().borders(Borders::ALL);
        f.render_widget(block2, vertical_chunks[1]);

        let textbox2 = Textbox::default()
            .fg(ratatui::style::Color::Yellow)
            .bg(ratatui::style::Color::Green)
            .hint_color(ratatui::style::Color::LightGreen)
            .cursor_color(ratatui::style::Color::DarkGray)
            .render_cursor(self.focused_textbox == 1);
        f.render_stateful_widget(textbox2, vertical_chunks[1].inner(ratatui::layout::Margin::new(1, 1)), &mut self.textbox2_state);
    }

pub fn render_cursor(self, render: bool) -> Self

Defines the visibility of cursor

Examples found in repository

examples/demo.rs (line 26)

    pub fn ui(&mut self, f: &mut Frame) {
        let size = f.area();

        let vertical_chunks = Layout::default()
            .direction(Direction::Vertical)
            .constraints([Constraint::Length(3), Constraint::Length(3), Constraint::Percentage(100)])
            .split(size);

        let block1 = Block::default().borders(Borders::ALL).title(format!("Use <TAB> to switch active textbox, <ESC> to exit demo"));
        f.render_widget(block1, vertical_chunks[0]);

        let textbox = Textbox::default()
            .render_cursor(self.focused_textbox == 0);
        let textbox_rect = Rect {
            x: 1,
            y: 1,
            width: 15,
            height: 1,
        };
        f.render_stateful_widget(textbox, textbox_rect, &mut self.textbox_state);

        let block2 = Block::default().borders(Borders::ALL);
        f.render_widget(block2, vertical_chunks[1]);

        let textbox2 = Textbox::default()
            .fg(ratatui::style::Color::Yellow)
            .bg(ratatui::style::Color::Green)
            .hint_color(ratatui::style::Color::LightGreen)
            .cursor_color(ratatui::style::Color::DarkGray)
            .render_cursor(self.focused_textbox == 1);
        f.render_stateful_widget(textbox2, vertical_chunks[1].inner(ratatui::layout::Margin::new(1, 1)), &mut self.textbox2_state);
    }

Trait Implementations

impl Default for Textbox

fn default() -> Self

Returns the “default value” for a type.

impl StatefulWidget for Textbox

type State = TextboxState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

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