ExRatatui.Event (ExRatatui v0.10.1)

Copy Markdown View Source

Terminal event structs.

Events are returned by ExRatatui.poll_event/1 and can be pattern matched to handle user input:

Example

case ExRatatui.poll_event(timeout) do
  %ExRatatui.Event.Key{code: "q"} -> :quit
  %ExRatatui.Event.Key{code: "up"} -> :scroll_up
  %ExRatatui.Event.Mouse{kind: "scroll_down"} -> :scroll_down
  %ExRatatui.Event.Resize{width: w, height: h} -> {:resize, w, h}
  %ExRatatui.Event.Paste{content: text} -> {:paste, text}
  %ExRatatui.Event.FocusGained{} -> :resume_animations
  %ExRatatui.Event.FocusLost{} -> :pause_animations
  nil -> :no_event
end

Summary

Types