Enum Event 

pub enum Event {
    Key(KeyEvent),
    Paste(String),
    Mouse(MouseEvent),
    Tick,
    Resize(Size),
}

Unified input events for Component::on_event.

Wraps the raw crossterm event types into a smaller, focused set. Convert from crossterm::event::Event using TryFrom — this filters out key releases and maps resize events automatically.

Variants

• Key(KeyEvent) — A key press or repeat. Key releases are filtered out during conversion.
• Paste(String) — Bracketed paste content (requires TerminalSession with bracketed paste enabled).
• Mouse(MouseEvent) — Mouse input (scroll, click, drag). Requires mouse capture.
• Tick — A periodic timer tick, useful for animations (e.g. Spinner).
• Resize(Size) — The terminal was resized to a new Size.

Conversion

use tui::Event;
use crossterm::event::Event as CrosstermEvent;

fn poll_event(raw: CrosstermEvent) -> Option<Event> {
    Event::try_from(raw).ok()
}

The TryFrom conversion returns Err(()) for events that components should not handle (key releases, focus gained/lost).

Variants

Key(KeyEvent)

Paste(String)

Mouse(MouseEvent)

Tick

Resize(Size)

Trait Implementations

impl TryFrom<Event> for Event

type Error = ()

The type returned in the event of a conversion error.

fn try_from(event: Event) -> Result<Self, ()>

Performs the conversion.