Struct Model 

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

Model is the Bubble Tea model for this text area element. Direct port from Go’s Model struct with all fields preserved

Fields

err: Option<String>

Optional error string surfaced by the component.

prompt: String

Prompt is printed at the beginning of each line

placeholder: String

Placeholder is the text displayed when the user hasn’t entered anything yet

show_line_numbers: bool

ShowLineNumbers, if enabled, causes line numbers to be printed after the prompt

end_of_buffer_character: char

EndOfBufferCharacter is displayed at the end of the input

key_map: TextareaKeyMap

Key bindings recognized by the widget.

focused_style: TextareaStyle

Style used when the textarea is focused.

blurred_style: TextareaStyle

Style used when the textarea is blurred.

cursor: Model

Embedded cursor model for caret rendering and blinking.

char_limit: usize

CharLimit is the maximum number of characters this input element will accept

max_height: usize

MaxHeight is the maximum height of the text area in rows

max_width: usize

MaxWidth is the maximum width of the text area in columns

Implementations

impl Model

pub fn new() -> Self

Create a new textarea model with default settings - port of Go’s New()

pub fn set_value(&mut self, s: impl Into<String>)

Set the value of the text input - port of Go’s SetValue

pub fn insert_string(&mut self, s: impl Into<String>)

Insert a string at the cursor position - port of Go’s InsertString

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

Insert a rune at the cursor position - port of Go’s InsertRune

pub fn value(&self) -> String

Get the current value as a string - port of Go’s Value()

pub fn length(&self) -> usize

Length returns the number of characters currently in the text input - port of Go’s Length()

pub fn line_count(&self) -> usize

LineCount returns the number of lines currently in the text input - port of Go’s LineCount()

pub fn line(&self) -> usize

Line returns the line position - port of Go’s Line()

pub fn focused(&self) -> bool

Focused returns the focus state on the model - port of Go’s Focused()

pub fn reset(&mut self)

Reset sets the input to its default state with no input - port of Go’s Reset()

pub fn width(&self) -> usize

Width returns the width of the textarea - port of Go’s Width()

pub fn height(&self) -> usize

Height returns the current height of the textarea - port of Go’s Height()

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

SetWidth sets the width of the textarea - port of Go’s SetWidth()

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

SetHeight sets the height of the textarea - port of Go’s SetHeight()

pub fn set_prompt_func( &mut self, prompt_width: usize, func: fn(usize) -> String, )

SetPromptFunc supersedes the Prompt field and sets a dynamic prompt instead Port of Go’s SetPromptFunc

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

SetCursor moves the cursor to the given position - port of Go’s SetCursor()

pub fn cursor_start(&mut self)

CursorStart moves the cursor to the start of the input field - port of Go’s CursorStart()

pub fn cursor_end(&mut self)

CursorEnd moves the cursor to the end of the input field - port of Go’s CursorEnd()

pub fn cursor_down(&mut self)

CursorDown moves the cursor down by one line - port of Go’s CursorDown()

pub fn cursor_up(&mut self)

CursorUp moves the cursor up by one line - port of Go’s CursorUp()

pub fn move_to_begin(&mut self)

Move to the beginning of input - port of Go’s moveToBegin()

pub fn move_to_end(&mut self)

Move to the end of input - port of Go’s moveToEnd()

pub fn line_info(&mut self) -> LineInfo

LineInfo returns line information for the current cursor position Port of Go’s LineInfo() - enhanced with better wrapped line handling

pub fn delete_before_cursor(&mut self)

Delete before cursor - port of Go’s deleteBeforeCursor()

pub fn delete_after_cursor(&mut self)

Delete after cursor - port of Go’s deleteAfterCursor()

pub fn delete_character_backward(&mut self)

Delete character backward - port of Go’s deleteCharacterBackward()

pub fn delete_character_forward(&mut self)

Delete character forward - port of Go’s deleteCharacterForward()

pub fn delete_word_backward(&mut self)

Delete word backward - port of Go’s deleteWordLeft()

pub fn delete_word_forward(&mut self)

Delete word forward - port of Go’s deleteWordRight()

pub fn insert_newline(&mut self)

Insert newline - port of Go’s InsertNewline()

pub fn character_left(&mut self, inside_line: bool)

Move cursor one character left - port of Go’s characterLeft()

pub fn character_right(&mut self)

Move cursor one character right - port of Go’s characterRight()

pub fn word_left(&mut self)

Move cursor one word left - port of Go’s wordLeft()

pub fn word_right(&mut self)

Move cursor one word right - port of Go’s wordRight()

pub fn uppercase_right(&mut self)

Transform word to uppercase - port of Go’s uppercaseRight()

pub fn lowercase_right(&mut self)

Transform word to lowercase - port of Go’s lowercaseRight()

pub fn capitalize_right(&mut self)

Transform word to title case - port of Go’s capitalizeRight()

pub fn transpose_left(&mut self)

Transpose characters - port of Go’s transposeLeft()

pub fn view(&mut self) -> String

View renders the text area - port of Go’s View()

pub fn scroll_down(&mut self, lines: usize)

Scroll viewport down by n lines - for testing viewport functionality

pub fn scroll_up(&mut self, lines: usize)

Scroll viewport up by n lines - for testing viewport functionality

pub fn cursor_line_number(&mut self) -> usize

Get cursor line number for display - port of Go’s cursorLineNumber()

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

Update handles incoming messages and updates the textarea state - port of Go’s Update()

pub fn copy_to_clipboard(&self, text: &str) -> Result<(), String>

Copy text to system clipboard

pub fn copy_selection(&self) -> Result<(), String>

Copy current selection to clipboard (if selection is implemented)

pub fn cut_selection(&mut self) -> Result<(), String>

Cut current selection to clipboard (if selection is implemented)

Trait Implementations

impl Component for Model

Focus sets the focus state on the model - port of Go’s Focus()

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

Sets the component to focused state.

fn blur(&mut self)

Sets the component to blurred (unfocused) state.

fn focused(&self) -> bool

Returns the current focus state of the component.

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Self

Returns the “default value” for a type.