Contents

Attribute Reference

Attribute Description
hx-boost progressively enhances anchors and forms to use AJAX requests
hx-confirm shows a confim() dialog before issuing a request
hx-delete issues a DELETE to the specified URL
hx-ext extensions to use for this element
hx-get issues a GET to the specified URL
hx-history-elt the element to snapshot and restore during history navigation
hx-include includes additional data in AJAX requests
hx-indicator the element to put the htmx-request class on during the AJAX request
hx-params filters the parameters that will be submitted with a request
hx-patch issues a PATCH to the specified URL
hx-post issues a POST to the specified URL
hx-prompt shows a prompt before submitting a request
hx-push-url pushes the URL into the location bar, creating a new history entry
hx-put issues a PUT to the specified URL
hx-select selects a subset of the server response to process
hx-sse establishes and listens to SSE sources for events
hx-swap-oob marks content in a response as being "Out of Band", i.e. swapped somewhere other than the target
hx-swap controls how the response content is swapped into the DOM (e.g. 'outerHTML' or 'beforeEnd')
hx-target specifies the target element to be swapped
hx-trigger specifies the event that triggers the request
hx-vars adds to the parameters that will be submitted with the request
hx-ws establishes a WebSocket or sends information to one

CSS Class Reference

Class Description
htmx-indicator A dynamically generated class that will toggle visible (opacity:1) when a htmx-request class is present
htmx-request Applied to either the element or the element specified with hx-indicator while a request is ongoing
htmx-settling Applied to a target after content is swapped, removed after it is settled
htmx-swapping Applied to a target before any content is swapped, removed after it is swapped

HTTP Header Reference

Request Headers Reference

Header Description
X-HTTP-Method-Override the HTTP verb for non-GET and POST requests
HX-Active-Element-Name the name of the active element if it exists
HX-Active-Element-Value the value of the active element if it exists
HX-Active-Element the id of the active element if it exists
HX-Current-URL the current URL of the browser
HX-Event-Target the id of the original event target
HX-Prompt the user response to an ic-prompt
HX-Request always true
HX-Target the id of the target element if it exists
HX-Trigger-Name the name of the triggered element if it exists
HX-Trigger the id of the triggered element if it exists

Response Headers Reference

Header Description
HX-Push pushes a new url into the history stack
HX-Trigger allows you to trigger client side events, see the documentation for more info

Event Reference

Event Description
htmx:afterOnLoad triggered after an AJAX request has completed processing a successful response
htmx:afterRequest triggered after an AJAX request has completed
htmx:afterSettle triggered after the DOM has settled
htmx:afterSwap triggered after new content has been swapped in
htmx:beforeOnLoad triggered before any response processing occurs
htmx:beforeRequest triggered before an AJAX request is made
htmx:beforeSwap triggered before a swap is done
htmx:configRequest triggered before the request, allows you to customize parameters, headers
htmx:historyCacheMiss triggered on a cache miss in the history subsystem
htmx:historyCacheMissError triggered on a unsuccessful remote retrieval
htmx:historyCacheMissLoad triggered on a succesful remote retrieval
htmx:historyRestore triggered when htmx handles a history restoration action
htmx:beforeHistorySave triggered before content is saved to the history cache
htmx:load triggered when new content is added to the DOM
htmx:noSSESourceError triggered when an element refers to a SSE event in its trigger, but no parent SSE source has been defined
htmx:onLoadError triggered when an exception occurs during the onLoad handling in htmx
htmx:oobErrorNoTarget triggered when an out of band element does not have a matching ID in the current DOM
htmx:prompt triggered after a prompt is shown
htmx:responseError triggered when an HTTP response error (non-200 or 300 response code) occurs
htmx:sendError triggered when a network error prevents an HTTP request from happening
htmx:sseError triggered when an error occurs with a SSE source
htmx:swapError triggered when an error occurs during the swap phase
htmx:targetError triggered when an invalid target is specified