summaryrefslogtreecommitdiffstatshomepage
path: root/www/attributes/hx-sse-src.md
diff options
context:
space:
mode:
Diffstat (limited to 'www/attributes/hx-sse-src.md')
-rw-r--r--www/attributes/hx-sse-src.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/www/attributes/hx-sse-src.md b/www/attributes/hx-sse-src.md
new file mode 100644
index 00000000..3f2eec5d
--- /dev/null
+++ b/www/attributes/hx-sse-src.md
@@ -0,0 +1,24 @@
+---
+layout: layout.njk
+title: </> htmx - hx-sse-src
+---
+
+## `hx-sse-src`
+
+The `hx-sse-src` attribute establishes a [Server Sent Event](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)
+`EventSource`, allowing children of the element to register for server sent event triggers.
+
+```html
+ <div hx-sse-src="/event_stream">
+ <div hx-get="/chatroom" hx-trigger="sse:chatter">
+ ...
+ </div>
+ </div>
+```
+
+This example establishes an SSE connection to the `event_stream` end point which then triggers
+a `GET` to the `/chatroom` url whenever the `chatter` event is seen.
+
+### Notes
+
+* `hx-sse-src` is not inherited