# PhoenixExRatatui v0.1.0 - Table of Contents

> Run ExRatatui apps inside Phoenix LiveView

## Pages

- [Overview](readme.md)
- [Getting Started](getting_started.md)
- [Contributing](contributing.md)
- [Changelog](changelog.md)

## Modules

- Components
  - [PhoenixExRatatui](PhoenixExRatatui.md): Run [`ExRatatui`](https://github.com/mcass19/ex_ratatui) apps inside a
[Phoenix LiveView](https://hexdocs.pm/phoenix_live_view).
  - [PhoenixExRatatui.LiveComponent](PhoenixExRatatui.LiveComponent.md): Macro that turns the calling module into a `Phoenix.LiveComponent`
hosting an embedded TUI — the same module is both the component and
the `ExRatatui.App` it drives.
  - [PhoenixExRatatui.LiveView](PhoenixExRatatui.LiveView.md): Macro that turns the calling module into a full-page TUI route — the
same module is both a `Phoenix.LiveView` and the `ExRatatui.App` that
drives it.

- Internals
  - [PhoenixExRatatui.Renderer.Html](PhoenixExRatatui.Renderer.Html.md): Encodes `ExRatatui.CellSession.Diff` payloads for transmission to the
browser via `Phoenix.LiveView.push_event/3`.
  - [PhoenixExRatatui.Telemetry](PhoenixExRatatui.Telemetry.md): `:telemetry` integration for `phoenix_ex_ratatui`.
  - [PhoenixExRatatui.Transport](PhoenixExRatatui.Transport.md): Connection-level helper that wires an `ExRatatui.App` to a
`Phoenix.LiveView` (or `Phoenix.LiveComponent`) over a freshly
constructed `ExRatatui.CellSession`.

