Struct Input 

pub struct Input { /* private fields */ }

Single-line text input with horizontal scrolling.

Defaults to Emacs-style bindings (Ctrl+A, Ctrl+E, Ctrl+K, etc.). Call set_vim_mode_enabled to opt into vim-style modal editing (Normal/Insert mode with hl, x, i, etc.).

The input scrolls horizontally when the text exceeds the render width so that the cursor always remains visible. Supports undo, yank, and kill-ring.

Implementations

impl Input

pub fn new() -> Self

Create a new empty input field with Emacs-style bindings.

pub fn vim_mode_enabled(&self) -> bool

Returns true if vim modal editing is enabled.

pub fn set_vim_mode_enabled(&mut self, enabled: bool)

Enable or disable vim modal editing.

When enabled the input starts in Normal mode; press i to insert, Escape to return to Normal. When disabled, Emacs-style bindings are always active.

pub fn mode(&self) -> InputVimMode

Current vim mode (only meaningful when vim mode is enabled).

pub fn set_mode(&mut self, mode: InputVimMode)

Switch to the given vim mode.

pub fn text(&self) -> &str

Borrow the current text content.

pub fn cursor(&self) -> usize

Current cursor position in grapheme indices.

pub fn scroll(&self) -> usize

Current horizontal scroll offset in grapheme indices.

pub fn set_text(&mut self, text: impl Into<String>)

Replace the entire text buffer and move the cursor to the end.

Trait Implementations

impl Component for Input

fn render(&self, width: u16) -> Result<Rendered, RenderError>

Render this component into lines of text at the given width.

fn handle_input(&mut self, event: &Event) -> InputResult

Handle an input event (key press, resize, mouse, etc.).

fn as_focusable(&self) -> Option<&dyn Focusable>

Cast this component to a Focusable reference, if supported.

fn as_focusable_mut(&mut self) -> Option<&mut dyn Focusable>

Cast this component to a mutable Focusable reference, if supported.

fn render_rect(&self, rect: Rect) -> Result<Rendered, RenderError>

Render this component into a specific rectangular area.

fn wants_key_release(&self) -> bool

Returns true if this component wants to receive KeyEventKind::Release events in addition to Press / Repeat.

impl Default for Input

fn default() -> Self

Returns the “default value” for a type.

impl Focusable for Input

fn focused(&self) -> bool

Returns true when this component currently has focus.

fn set_focused(&mut self, focused: bool)

Set or clear the focused state.