Skip to main content

Input

Struct Input 

Source
pub struct Input { /* private fields */ }
Expand description

Input component - single-line text input.

Implementations§

Source§

impl Input

Source

pub fn new() -> Self

Create a new input component.

Source

pub fn with_prompt(prompt: &str) -> Self

Create an input with a custom prompt.

Source

pub fn with_placeholder(placeholder: &str) -> Self

Create an input with a placeholder.

Source

pub fn get_value(&self) -> String

Get the current value.

Source

pub fn set_value(&self, value: &str)

Set the value.

Source

pub fn clear(&self)

Clear the input.

Source

pub fn on_submit(&self, callback: Arc<dyn Fn(&str) + Send + Sync>)

Set callback for when input is submitted (Enter pressed).

Source

pub fn on_escape(&self, callback: Arc<dyn Fn() + Send + Sync>)

Set callback for when escape is pressed.

Source

pub fn on_change(&self, callback: Arc<dyn Fn(&str) + Send + Sync>)

Set callback for when value changes.

Source

pub fn handle_paste(&self, pasted_text: &str)

Handle bracketed paste.

Source

pub fn handle_key(&self, key: KeyEvent)

Handle key input.

Trait Implementations§

Source§

impl Component for Input

Source§

fn render(&self, width: usize) -> Vec<String>

Render the component to lines for the given viewport width. Read more
Source§

fn invalidate(&self)

Invalidate any cached rendering state. Called when theme changes or when component needs to re-render from scratch.
Source§

fn as_any(&self) -> &dyn Any

Downcast to Any for runtime type checking. This enables the layout system to check for LayoutNodeProvider.
Source§

fn handle_input(&self, _data: &str) -> bool

Optional handler for keyboard input when component has focus. Read more
Source§

fn wants_key_release(&self) -> bool

If true, component receives key release events (Kitty protocol). Default is false - release events are filtered out.
Source§

impl Default for Input

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Focusable for Input

Source§

fn set_focused(&self, focused: bool)

Set by TUI when focus changes. Component should emit CURSOR_MARKER when true.
Source§

fn is_focused(&self) -> bool

Check if the component is currently focused.

Auto Trait Implementations§

§

impl !Freeze for Input

§

impl RefUnwindSafe for Input

§

impl Send for Input

§

impl Sync for Input

§

impl Unpin for Input

§

impl UnsafeUnpin for Input

§

impl UnwindSafe for Input

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.