# `ExRatatui.Event`
[🔗](https://github.com/mcass19/ex_ratatui/blob/v0.7.1/lib/ex_ratatui/event.ex#L1)

Terminal event structs.

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

  * `ExRatatui.Event.Key` — keyboard events (key presses, releases, repeats)
  * `ExRatatui.Event.Mouse` — mouse events (clicks, scrolls, drags)
  * `ExRatatui.Event.Resize` — terminal resize events

## 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}
      nil -> :no_event
    end

# `t`

```elixir
@type t() ::
  ExRatatui.Event.Key.t()
  | ExRatatui.Event.Mouse.t()
  | ExRatatui.Event.Resize.t()
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*