TermUI.Widgets.TextInput (TermUI v0.2.0)

View Source

TextInput widget for single-line and multi-line text input.

Provides text editing with cursor movement, auto-growing height, and scrolling for content that exceeds the visible area.

Usage

TextInput.new(
  value: "",
  placeholder: "Enter text...",
  width: 40,
  multiline: true,
  max_visible_lines: 5
)

Features

  • Single-line and multi-line modes
  • Ctrl+Enter for newline insertion (multiline)
  • Auto-growing height up to max_visible_lines
  • Scrollable area when content exceeds visible lines
  • Cursor movement and text editing
  • Placeholder text support
  • Focus state handling

Keyboard Controls

  • Left/Right: Move cursor horizontally
  • Up/Down: Move cursor between lines (multiline)
  • Home/End: Move to start/end of line
  • Ctrl+Home/End: Move to start/end of text
  • Backspace: Delete character before cursor
  • Delete: Delete character at cursor
  • Ctrl+Enter: Insert newline (multiline mode)
  • Enter: Submit (single-line) or insert newline if configured
  • Escape: Blur input

Summary

Functions

clear(state)

Clear the text input.

get_cursor(state)

Get the cursor position as {row, col}.

get_line_count(state)

Get the number of lines.

get_value(state)

Get the current text value.

new(opts \\ [])

Creates new TextInput widget props.

set_focused(state, focused)

Set focus state.

set_value(state, value)

Set the text value programmatically.

Functions

clear(state)

@spec clear(map()) :: map()

Clear the text input.

get_cursor(state)

@spec get_cursor(map()) :: {non_neg_integer(), non_neg_integer()}

Get the cursor position as {row, col}.

get_line_count(state)

@spec get_line_count(map()) :: non_neg_integer()

Get the number of lines.

get_value(state)

@spec get_value(map()) :: String.t()

Get the current text value.

new(opts \\ [])

@spec new(keyword()) :: map()

Creates new TextInput widget props.

Options

  • :value - Initial text value (default: "")
  • :placeholder - Placeholder text when empty (default: "")
  • :width - Widget width in characters (default: 40)
  • :multiline - Enable multi-line mode (default: false)
  • :max_lines - Maximum number of lines allowed, nil for unlimited (default: nil)
  • :max_visible_lines - Lines visible before scrolling (default: 5)
  • :on_change - Callback when value changes: fn(value) -> any
  • :on_submit - Callback when submitted: fn(value) -> any
  • :enter_submits - Enter key submits instead of newline in multiline (default: false)
  • :disabled - Disable input (default: false)
  • :style - Text style
  • :focused_style - Style when focused
  • :placeholder_style - Placeholder text style

set_focused(state, focused)

@spec set_focused(map(), boolean()) :: map()

Set focus state.

set_value(state, value)

@spec set_value(map(), String.t()) :: map()

Set the text value programmatically.