Packages

datastar_plug

0.1.0
0.2.3 0.2.2 0.2.1 0.2.0 0.1.0

Stateless SSE helpers for Datastar integration in any Plug/Phoenix app.

HexDocs

Current section

Files

Jump to
Readme
5 Versions
2 Dependencies
Dependants
Files
Activity
datastar_plug CHANGELOG.md
Raw

CHANGELOG.md 

# Changelog



All notable changes to this project will be documented in this file.



The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).



## [Unreleased]



## [0.1.0] - 2026-03-14



### Added



- `Datastar.init_sse/1` — Initialises a chunked `text/event-stream` response

  with the required SSE headers (`cache-control`, `connection`, `x-accel-buffering`).

- `Datastar.patch_fragment/3` — Sends a `datastar-patch-elements` SSE event to

  patch HTML into the DOM. Supports all Datastar merge modes (`morph`, `inner`,

  `outer`, `prepend`, `append`, `before`, `after`, `remove`) and an optional

  CSS selector. Multi-line HTML is split into one `data: elements` line per

  source line as required by the SSE protocol.

- `Datastar.patch_signals/2` — Sends a `datastar-patch-signals` SSE event to

  merge a map of values into the Datastar client signal store. Values are

  JSON-encoded via `Jason`.

- `Datastar.execute_script/2` — Executes a JavaScript snippet on the client by

  appending a `<script>` tag to the document `<body>` via a

  `datastar-patch-elements` event.

- `Datastar.redirect_to/2` — Redirects the browser to a URL using a

  `setTimeout`-wrapped `window.location.href` assignment. The URL is

  JSON-encoded to prevent injection.

- `Datastar.remove_fragment/2` — Removes DOM elements matching a CSS selector

  by sending a `datastar-patch-elements` event with `mode: remove`.

- `Datastar.close_sse/1` — No-op pipeline terminator that documents intent

  (the SSE response body is complete).

- `Datastar.parse_signals/1` — Decodes Datastar signals from controller params

  for both GET requests (signals as a JSON string in `?datastar=`) and

  POST/PUT/PATCH/DELETE requests (signals as the decoded JSON body). Returns

  `%{}` on parse failure so callers always receive a map.



[Unreleased]: https://github.com/rskinnerc/datastar_plug/compare/v0.1.0...HEAD

[0.1.0]: https://github.com/rskinnerc/datastar_plug/releases/tag/v0.1.0