Reference

Attributes, headers, events, and configuration.

Attributes33 attributes

Requests

`hx-get`	Issues `GET` request to specified URL
`hx-post`	Issues `POST` request to specified URL
`hx-put`	Issues `PUT` request to specified URL
`hx-patch`	Issues `PATCH` request to specified URL
`hx-delete`	Issues `DELETE` request to specified URL

Request Control

`hx-trigger`	Controls when element issues requests
`hx-swap`	Controls how response is inserted
`hx-target`	Controls where response is inserted
`hx-select`	Controls which response part is inserted
`hx-swap-oob`	Marks response elements to swap into page by ID
`hx-select-oob`	Picks response elements to swap into page by ID
`hx-confirm`	Shows confirmation dialog before request

Scripting

`hx-on`	Runs inline JavaScript when event fires

Data

`hx-vals`	Adds values to request parameters
`hx-include`	Includes additional element values in request
`hx-headers`	Adds custom headers to request
`hx-encoding`	Sets request encoding type

History

`hx-push-url`	Pushes URL into browser history
`hx-replace-url`	Replaces current URL in browser history
`hx-history-elt`	Marks element to swap on history restore

Enhancements

`hx-boost`	Converts links and forms to AJAX
`hx-preload`	Preloads content before user triggers request
`hx-optimistic`	Shows optimistic content during request

Advanced

`hx-indicator`	Specifies loading indicator element
`hx-status`	Handles responses differently by status code
`hx-sync`	Synchronizes requests between elements
`hx-validate`	Validates before submitting request
`hx-disable`	Disables elements during request
`hx-ignore`	Disables htmx processing for element
`hx-preserve`	Preserves element during swaps
`hx-action`	Specifies URL to receive request
`hx-method`	Specifies HTTP method for request
`hx-config`	Configures request behavior

Headers16 headers

Request

`HX-Request`	Indicates request was made by htmx
`HX-Request-Type`	Indicates `partial` or `full` page request
`HX-Current-URL`	Contains browser URL when request started
`HX-Source`	Identifies element that triggered the request
`HX-Target`	Identifies element that will receive response
`HX-Boosted`	Indicates boosted navigation request
`HX-History-Restore-Request`	Indicates history navigation (back/forward)

Response

`HX-Trigger`	Triggers client-side events with `htmx.trigger()`
`HX-Location`	Navigates with `htmx.ajax()`
`HX-Redirect`	Redirects by setting `location.href`
`HX-Refresh`	Reloads page with `location.reload()`
`HX-Retarget`	Overrides swap target from server
`HX-Reswap`	Overrides swap style from server
`HX-Reselect`	Overrides content selection from server
`HX-Replace-Url`	Replaces current URL in browser history
`HX-Push-Url`	Pushes URL into browser history stack

Events31 events

Request Lifecycle

`htmx:config:request`	Fires before request data is encoded
`htmx:confirm`	Fires before handling `hx-confirm`
`htmx:before:request`	Fires immediately before `fetch()`
`htmx:before:response`	Fires after `fetch()`, before `response.text()`
`htmx:after:request`	Fires after `response.text()`
`htmx:response:error`	Fires for HTTP status 400 or higher
`htmx:before:swap`	Fires before DOM update
`htmx:before:settle`	Fires after DOM insertion, before settle tasks
`htmx:after:settle`	Fires after settle tasks
`htmx:after:swap`	Fires after DOM update
`htmx:finally:request`	Fires after lifecycle ends, including failures
`htmx:error`	Fires after request or swap exception
`htmx:abort`	Aborts in-flight request

Elements

`htmx:before:init`	Fires before element initialization
`htmx:after:init`	Fires after element initialization
`htmx:before:process`	Fires before DOM node processing
`htmx:after:process`	Fires after DOM node processing
`htmx:process:{type}`	Fires during registered template processing
`htmx:after:implicitInheritance`	Fires after implicit inheritance
`htmx:before:cleanup`	Fires before element data removal
`htmx:after:cleanup`	Fires after element data removal
`load`	Fires after element initialization

History

`htmx:before:history:update`	Fires before browser history update
`htmx:after:history:update`	Fires after browser history update
`htmx:after:history:push`	Fires after history push
`htmx:after:history:replace`	Fires after history replacement
`htmx:before:history:restore`	Fires before history restoration

View Transitions

`htmx:before:viewTransition`	Fires before view transition starts
`htmx:after:viewTransition`	Fires after view transition completes

Triggers

`intersect`	Fires when element enters viewport
`every`	Fires at each polling interval

Config24 config

Core

`htmx.config`	Configures htmx behavior globally
`htmx.version`	Reports current htmx version (read-only)
`htmx.config.prefix`	Sets secondary attribute prefix
`htmx.config.metaCharacter`	Replaces `:` in attribute modifiers
`htmx.config.extensions`	Restricts extension registration by name

Requests

`htmx.config.defaultTimeout`	Sets default request timeout in `ms`
`htmx.config.mode`	Sets request mode for `fetch()`

Swaps

`htmx.config.defaultSwap`	Sets default swap style for responses
`htmx.config.defaultSwapEmpty`	Controls main swap when response body is empty
`htmx.config.noSwap`	Sets HTTP status codes that skip swap
`htmx.config.transitions`	Enables View Transitions API support
`htmx.config.defaultSettleDelay`	Sets swap-to-settle delay in `ms`
`htmx.config.defaultFocusScroll`	Scrolls to focused element after swap

Morphing

`htmx.config.morphIgnore`	Preserves attribute prefixes during morphing
`htmx.config.morphSkip`	Skips morphing for specific elements
`htmx.config.morphSkipChildren`	Skips morphing children of specific elements
`htmx.config.morphScanLimit`	Limits siblings scanned during morph matching

Indicators

`htmx.config.includeIndicatorCSS`	Includes built-in loading indicator CSS
`htmx.config.indicatorClass`	Sets class hidden by built-in indicator CSS
`htmx.config.requestClass`	Sets class applied during requests

Behavior

`htmx.config.history`	Controls htmx browser history management
`htmx.config.implicitInheritance`	Enables implicit attribute inheritance
`htmx.config.inlineScriptNonce`	Sets nonce on inline scripts generated by htmx
`htmx.config.logAll`	Logs all htmx events to console

Methods11 methods

Requests

`htmx.ajax()`	Issues an htmx request

DOM

`htmx.find()`	Finds first matching element
`htmx.findAll()`	Finds all matching elements
`htmx.process()`	Processes htmx attributes on element
`htmx.swap()`	Swaps HTML content

Events

`htmx.on()`	Listens for htmx events
`htmx.onLoad()`	Executes callback when elements load
`htmx.trigger()`	Triggers custom events

Extensions

`htmx.registerExtension()`	Registers htmx extension

Timing

`htmx.parseInterval()`	Parses time intervals to milliseconds
`htmx.timeout()`	Creates timeout `Promise`

Tags1 tags

`<hx-partial>`	Targets multiple elements with one response