itsscb/htmx
1
0
Fork 0
mirror of https://github.com/bigskysoftware/htmx.git synced 2025-10-02 15:25:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated to note that change in format and add info about optional prefix

Browse Source
This commit is contained in:
Omen Apps 2021-02-15 12:12:38 -05:00
parent 8b2d6b0475
commit 8d8a106219
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
www/attributes/hx-ws.md
View File

@ -8,7 +8,7 @@ title: </> htmx - hx-ws
The `hx-ws` allows you to work with [Web Sockets](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_client_applications)
directly from HTML. The value of the attribute can be one or more of the following, separated by commas:
* `connect:<url>` - A URL to establish an `WebSocket` connection against
* `connect:<url>` or `connect:<prefix>:<url>` - A URL to establish an `WebSocket` connection against. Prefixes `ws` or `wss` can optionally be specified. If not specified, HTMX defaults to add the `wss` prefix to the url.
* `send` - Sends a message to the nearest websocket based on the trigger value for the element (either the natural event
of the event specified by [`hx-trigger`])
@ -25,7 +25,7 @@ Here is an example:
</div>
```
This example establishes a WebSocket to the `chatroom` end point. Content that is send down from the websocket will
This example establishes a WebSocket to the `chatroom` end point. Content that is sent down from the websocket will
be parsed as HTML and swapped in by the `id` property, using the same logic as [Out of Band Swaps](/attributes/hx-swap-oob).
The form uses the `send` syntax to indicate that when it is submitted, the form values should be serialized as JSON

2
www/docs.md
View File

@ -481,7 +481,7 @@ These features are under active development, so please let us know if you are wi
If you wish to establish a `WebSocket` connection in htmx, you use the [hx-ws](/attributes/hx-ws) attribute:
```html
<div hx-ws="connect wss:/chatroom">
<div hx-ws="connect:wss:/chatroom">
<div id="chat_room">
...
</div>