# star_view v0.3.2 - Table of Contents

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

## Pages

- [README](readme.md)
- [LiveView vs StarView](liveview_vs_star_view.md)

## Modules

- 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.JSON](StarView.JSON.md): Tiny wrapper around Erlang/OTP's native `:json` module.
  - [StarView.Scripts](StarView.Scripts.md): Script helpers implemented through Datastar element patches.

  - [StarView.ServerSentEventGenerator](StarView.ServerSentEventGenerator.md): Plug-based Datastar Server-Sent Event generator.
  - [StarView.Signals](StarView.Signals.md): Datastar signal reading and `datastar-patch-signals` helpers.

  - [StarView.Utility.StreamRegistry](StarView.Utility.StreamRegistry.md): Opt-in per-tab stream deduplication.

- 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.Phoenix.Controller](StarView.Phoenix.Controller.md): Phoenix controller helpers for StarView.
  - [StarView.Phoenix.Dispatch](StarView.Phoenix.Dispatch.md): Marker-based Datastar dispatch for Phoenix controllers.
  - [StarView.StarView](StarView.StarView.md): Behaviour for StarView-enabled Phoenix controllers.

- Exceptions
  - [StarView.Signals.ReadError](StarView.Signals.ReadError.md): Raised when Datastar signals cannot be decoded from the request body.

## Mix Tasks

- [mix star_view.install](Mix.Tasks.StarView.Install.md): Installs StarView into your project
- [mix star_view.setup.datastar](Mix.Tasks.StarView.Setup.Datastar.md): Configures Datastar dispatch routes and HTTPS for dev
- [mix star_view.setup.search_controller](Mix.Tasks.StarView.Setup.SearchController.md): Generates an example StarView demo controller with Datastar
- [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): Patches the Phoenix web module with StarView controller support