Struct TextArea 

pub struct TextArea {
    pub err: Option<String>,
    pub prompt: String,
    pub placeholder: String,
    pub show_line_numbers: bool,
    pub end_of_buffer_character: char,
    pub key_map: KeyMap,
    pub focused_style: Styles,
    pub blurred_style: Styles,
    pub cursor: Cursor,
    pub char_limit: usize,
    pub max_height: usize,
    pub max_width: usize,
    /* private fields */
}

Multi-line text area model.

Fields

err: Option<String>

Current error.

prompt: String

Prompt string (displayed at start of each line).

placeholder: String

Placeholder text.

show_line_numbers: bool

Whether to show line numbers.

end_of_buffer_character: char

End of buffer character.

key_map: KeyMap

Key bindings.

focused_style: Styles

Style for focused state.

blurred_style: Styles

Style for blurred state.

cursor: Cursor

Cursor model.

char_limit: usize

Character limit (0 = no limit).

max_height: usize

Maximum height in rows.

max_width: usize

Maximum width in columns.

Implementations

impl TextArea

pub fn new() -> Self

Creates a new textarea with default settings.

pub fn set_value(&mut self, s: &str)

Sets the value of the textarea.

pub fn insert_string(&mut self, s: &str)

Inserts a string at the cursor position.

pub fn insert_rune(&mut self, r: char)

Inserts a single character at the cursor position.

pub fn value(&self) -> String

Returns the current value as a string.

pub fn length(&self) -> usize

Returns the total length in characters.

pub fn line_count(&self) -> usize

Returns the number of lines.

pub fn line(&self) -> usize

Returns the current line number (0-indexed).

pub fn cursor_col(&self) -> usize

Returns the current cursor column (0-indexed, in characters).

pub fn cursor_pos(&self) -> (usize, usize)

Returns the current cursor position (row, col) in character indices.

pub fn cursor_byte_offset(&self) -> usize

Returns the cursor position as a byte offset into the string returned by Self::value.

pub fn set_cursor_byte_offset(&mut self, offset: usize)

Sets the cursor position based on a byte offset into the string returned by Self::value.

If the offset points to the newline separator between lines, the cursor is placed at the end of the preceding line. Offsets beyond the end of the buffer clamp to the end.

pub fn cursor_down(&mut self)

Moves cursor down one line.

pub fn cursor_up(&mut self)

Moves cursor up one line.

pub fn set_cursor_col(&mut self, col: usize)

Sets cursor column position.

pub fn cursor_start(&mut self)

Moves cursor to start of line.

pub fn cursor_end(&mut self)

Moves cursor to end of line.

pub fn cursor_left(&mut self)

Moves cursor left one character.

pub fn cursor_right(&mut self)

Moves cursor right one character.

pub fn focused(&self) -> bool

Returns whether the textarea is focused.

pub fn focus(&mut self) -> Option<Cmd>

Focuses the textarea.

pub fn blur(&mut self)

Blurs the textarea.

pub fn reset(&mut self)

Resets the textarea to empty.

pub fn set_width(&mut self, w: usize)

Sets the width of the textarea.

pub fn width(&self) -> usize

Returns the width.

pub fn set_height(&mut self, h: usize)

Sets the height of the textarea.

pub fn height(&self) -> usize

Returns the height.

pub fn update(&mut self, msg: Message) -> Option<Cmd>

Updates the textarea based on messages.

pub fn view(&self) -> String

Renders the textarea.

Trait Implementations

impl Clone for TextArea

fn clone(&self) -> TextArea

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextArea

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

Formats the value using the given formatter.

impl Default for TextArea

fn default() -> Self

Returns the “default value” for a type.

impl Model for TextArea

fn init(&self) -> Option<Cmd>

Initialize the textarea and return a blink command if focused.

fn update(&mut self, msg: Message) -> Option<Cmd>

Update the textarea state based on incoming messages.

fn view(&self) -> String

Render the textarea.