Note: This attribute will be migrated to an extension in htmx 2.0, which is available now. Please visit the WebSockets extension page to learn about the new implementation of Web Sockets as an extension.
hx-ws allows you to work with Web Sockets
directly from HTML. The value of the attribute can be one or more of the following, separated by commas:
connect:<prefix>:<url>- A URL to establish an
wsscan optionally be specified. If not specified, HTMX defaults to add the location's scheme-type, host and port to have browsers send cookies via websockets.
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 [
Here is an example:
<div hx-ws="connect:/chatroom"> <div id="chat_room"> ... </div> <form hx-ws="send"> <input name="chat_message"> </form> </div>
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.
The form uses the
send syntax to indicate that when it is submitted, the form values should be serialized as JSON
and send to the nearest enclosing
The serialized values will include a field,
HEADERS, that includes the headers normally submitted with an htmx
After an unexpected connection loss due to
Service Restart or
Try Again Later,
reconnecting is tried until successful.
The default reconnection interval is implemented with the full-jitter exponential-backoff algorithm.
Own implementations can be provided by setting
htmx.config.wsReconnectDelay to a function with
retryCount as its only parameter.
Htmx includes a WebSockets test server with many more examples of how to use Server Sent Events. Download the htmx source code from github and navigate to /test/servers/ws to experiment.
hx-wsis not inherited