# star_view v0.7.0 - Table of Contents

> Elixir SDK for Datastar SSE events with Plug and Phoenix helpers.

## GUIDES

- Introduction
  - [Overview](overview.md)
  - [Thinking in Phoenix, Datastar and StarView](mental_model.md)
  - [Installation](installation.md)
  - [Agent skill](agent_skill.md)

- Phoenix
  - [Phoenix Web Module](web_module.md)
  - [StarView Layout](layout.md)
  - [Magic-Link Auth Pages](auth.md)
  - [Pages, streams and shared components](pages.md)
  - [Development Server](development_server.md)
  - [Compression in the HTTP Stack](compression.md)

- Core Concepts
  - [patch_signals/3](patch_signals.md)
  - [Actions, URLs, and Quoted Values](actions.md)
  - [Checked event references](checked_events.md)
  - [patch_element/3](patch_element.md)
  - [Per-Tab Stream Deduplication](stream_deduplication.md)
  - [CSRF](csrf.md)

- Comparison
  - [LiveView vs StarView](liveview_vs_star_view.md)

- Examples
  - [Phoenix Counter and Component Patches](phoenix_counter.md)
  - [Manual Plug Endpoints and Request Boundaries](plug_endpoints.md)
  - [PubSub Streams with Bounded Ownership](pubsub_stream.md)
  - [Reactive Rendering After Scoped Invalidations](reactive_rendering.md)
  - [STAR Templates (Experimental)](star_templates.md)

- Reference
  - [API Overview](api_overview.md)
  - [Migration from Dstar](migration_from_dstar.md)
  - [Troubleshooting](troubleshooting.md)

- Release Notes
  - [Changelog](changelog.md)

## Modules

- [StarView.Template.Program](StarView.Template.Program.md): A compiled `~STAR` rendering program. Compiler output; not a construction API.

- Experimental templates
  - [StarView.Template](StarView.Template.md): StarView's own template representation, rendering to HTML and diffing into
element patches. Compiled templates hold a `StarView.Template.Program` with
evaluated values. Hand-built templates hold `StarView.Template.Node` trees.
  - [StarView.Template.Formatter](StarView.Template.Formatter.md): Mix formatter plugin for the experimental `~STAR` sigil.
  - [StarView.Template.Node](StarView.Template.Node.md): One node of a `StarView.Template` tree.
  - [StarView.Template.Patch](StarView.Template.Patch.md): One element patch produced by `StarView.Template.diff/2`.
  - [StarView.Template.Sigils](StarView.Template.Sigils.md): The experimental `~STAR` sigil compiles HEEx syntax into a StarView-owned tree.

- Core
  - [StarView](StarView.md): Elixir SDK helpers for Datastar.
  - [StarView.Actions](StarView.Actions.md): Datastar action expression helpers.
  - [StarView.Elements](StarView.Elements.md): Datastar `datastar-patch-elements` helpers.

  - [StarView.Events](StarView.Events.md): Opt-in event contracts derived from actual `handle_event/3` clauses.
  - [StarView.JSON](StarView.JSON.md): Tiny wrapper around Erlang/OTP's native `:json` module.
  - [StarView.SSE](StarView.SSE.md): Plug-based Datastar Server-Sent Event generator.
  - [StarView.Scripts](StarView.Scripts.md): Script helpers implemented through Datastar element patches.

  - [StarView.Signals](StarView.Signals.md): Datastar signal reading and `datastar-patch-signals` helpers.

  - [StarView.Stream](StarView.Stream.md): Opens an SSE stream and owns its receive loop, liveness probes, and teardown.
  - [StarView.StreamRegistry](StarView.StreamRegistry.md): Opt-in per-tab stream ownership with atomic claims and bounded handover.

- Plugs
  - [StarView.Plug.Dispatch](StarView.Plug.Dispatch.md): Allowlisted Datastar event dispatch plug.
  - [StarView.Plug.RenameCsrfParam](StarView.Plug.RenameCsrfParam.md): Copies a Datastar CSRF signal into `_csrf_token` for `Plug.CSRFProtection`.

- Phoenix
  - [StarView.Component](StarView.Component.md): Shared UI + its event handlers in one module — for drawers, pickers,
and other components used across many pages.
  - [StarView.Controller](StarView.Controller.md): Phoenix controller helpers for StarView.
  - [StarView.Dispatch](StarView.Dispatch.md): Marker-based Datastar dispatch for Phoenix controllers.
  - [StarView.Page](StarView.Page.md): One module per page: render, event handlers, stream callbacks, and
colocated function components.
  - [StarView.Page.Assigns](StarView.Page.Assigns.md): Assign helpers that work in both halves of a StarView page module.
  - [StarView.Page.Helpers](StarView.Page.Helpers.md): Template and handler helpers imported by `use StarView.Page`.
  - [StarView.Page.Plug](StarView.Page.Plug.md): Drives explicitly routed `StarView.Page` callbacks.
  - [StarView.Router](StarView.Router.md): Explicit Phoenix routes for optional StarView pages and components.

- Testing
  - [StarView.Test](StarView.Test.md): Assertions for StarView SSE responses in `Plug.Test` / `Phoenix.ConnTest`
tests. Chunked SSE bodies accumulate on the test adapter; these helpers
parse them back into events.

- Exceptions
  - [StarView.SSE.TransportError](StarView.SSE.TransportError.md): Raised when the Plug adapter rejects an SSE write.
  - [StarView.Signals.ReadError](StarView.Signals.ReadError.md): Raised when Datastar signals cannot be decoded from a request.
  - [StarView.Template.StaleProgramError](StarView.Template.StaleProgramError.md): A compiled snapshot's rendering code changed. Build a fresh template.

## Mix Tasks

- [mix dev](Mix.Tasks.Dev.md): Delegates to `mix star_view.server`.

- [mix star_view.install](Mix.Tasks.StarView.Install.md): Installs StarView into your project
- [mix star_view.server](Mix.Tasks.StarView.Server.md): Starts `mix phx.server` with browser opening enabled.
- [mix star_view.setup.auth](Mix.Tasks.StarView.Setup.Auth.md): Generates StarView magic-link auth pages for AshAuthentication
- [mix star_view.setup.datastar](Mix.Tasks.StarView.Setup.Datastar.md): Configures StarView dev URL and HTTPS
- [mix star_view.setup.dispatch](Mix.Tasks.StarView.Setup.Dispatch.md): Adds a POST `/ds/:module/:event` route for `StarView.Dispatch` and inserts
`StarView.Plug.RenameCsrfParam` before browser CSRF protection.
- [mix star_view.setup.search_controller](Mix.Tasks.StarView.Setup.SearchController.md): Generates an example StarView demo controller with Datastar
- [mix star_view.setup.stream_page](Mix.Tasks.StarView.Setup.StreamPage.md): Generates an SSE streaming demo page driven by Phoenix.PubSub
- [mix star_view.setup.streaming](Mix.Tasks.StarView.Setup.Streaming.md): Adds StarView stream registry to the supervision tree
- [mix star_view.setup.web_module](Mix.Tasks.StarView.Setup.WebModule.md): Adds a StarView section to the Phoenix web module
- [mix star_view.trust](Mix.Tasks.StarView.Trust.md): Adds the configured StarView development host to `/etc/hosts` and generates a
browser-trusted development certificate with `mkcert`.