hx

Official Intersect Documentation

pub opaque type EventModifier

IntersectConfig

</>

Configuration options for the intersect event.

pub type IntersectConfig {
  Root(selector: String)
  Threshold(value: Float)
}

Constructors

```
Root(selector: String)
```
Specify the root element for intersection observation
```
Threshold(value: Float)
```
Intersection threshold (0.0 to 1.0)

Queue

</>

Queue behavior for synchronized requests.

Used with hx.sync to control request queuing.

Official Sync Documentation

pub type Queue {
  First
  Last
  All
}

Constructors

```
First
```
Process the first request, ignore subsequent
```
Last
```
Process the last request, ignore previous
```
All
```
Process all requests

ScrollPosition

</>

Scroll position specification for swap modifiers.

pub type ScrollPosition {
  Top
  Bottom
}

Constructors

```
Top
```
Scroll to the top
```
Bottom
```
Scroll to the bottom

ScrollTarget

</>

Scroll target specification for swap modifiers.

pub type ScrollTarget {
  TargetScroll(ScrollPosition)
  ElementScroll(selector: String, position: ScrollPosition)
  WindowScroll(ScrollPosition)
}

Constructors

```
TargetScroll(ScrollPosition)
```
Scroll the swap target element

ElementScroll(selector: String, position: ScrollPosition)

Scroll a specific element by CSS selector

```
WindowScroll(ScrollPosition)
```
Scroll the window

Selector

</>

Extended CSS selectors for targeting elements.

HTMX extends standard CSS selectors with additional keywords for more flexible targeting.

Official Extended CSS Selectors Documentation

pub type Selector {
  Selector(selector: String)
  Document
  Window
  Closest(selector: String)
  Find(selector: String)
  Next(selector: String)
  Previous(selector: String)
  This
}

Constructors

```
Selector(selector: String)
```
Standard CSS selector (e.g., “#id”, “.class”, “div > p”)
```
Document
```
Target the document
```
Window
```
Target the window
```
Closest(selector: String)
```
Find the closest ancestor matching the selector
```
Find(selector: String)
```
Find the first descendant matching the selector
```
Next(selector: String)
```
Find the next sibling matching the selector
```
Previous(selector: String)
```
Find the previous sibling matching the selector
```
This
```
Target the element itself

ShowTarget

</>

Show target specification for swap modifiers.

pub type ShowTarget {
  TargetShow(ScrollPosition)
  ElementShow(selector: String, position: ScrollPosition)
  WindowShow(ScrollPosition)
}

Constructors

```
TargetShow(ScrollPosition)
```
Show the swap target in viewport

ElementShow(selector: String, position: ScrollPosition)

Show a specific element in viewport

```
WindowShow(ScrollPosition)
```
Show in window viewport

Swap

</>

Different ways content can be swapped in the DOM.

Controls how the response content replaces existing content.

Official Swap Documentation

pub type Swap {
  InnerHTML
  OuterHTML
  TextContent
  Afterbegin
  Beforebegin
  Beforeend
  Afterend
  Delete
  SwapNone
}

Constructors

```
InnerHTML
```
Replace the inner HTML of the target element
```
OuterHTML
```
Replace the entire target element
```
TextContent
```
Replace the text content of the target element
```
Afterbegin
```
Insert inside the target, before its first child
```
Beforebegin
```
Insert before the target element (as a sibling)
```
Beforeend
```
Insert inside the target, after its last child
```
Afterend
```
Insert after the target element (as a sibling)
```
Delete
```
Delete the target element
```
SwapNone
```
Do not swap content

SwapConfig

</>

Options for modifying swap behavior.

These modifiers can be used with swap_with and swap_oob_with.

Official Swap Modifiers Documentation

pub type SwapConfig {
  Transition(Bool)
  SwapTiming(duration.Duration)
  Settle(duration.Duration)
  IgnoreTitle(Bool)
  ScrollTo(ScrollTarget)
  Show(ShowTarget)
  FocusScroll(Bool)
}

Constructors

```
Transition(Bool)
```
Enable/disable view transitions
```
SwapTiming(duration.Duration)
```
Delay before swapping content
```
Settle(duration.Duration)
```
Duration to wait after swap before settling
```
IgnoreTitle(Bool)
```
Whether to ignore title updates from response
```
ScrollTo(ScrollTarget)
```
Scroll configuration
```
Show(ShowTarget)
```
Show configuration
```
FocusScroll(Bool)
```
Whether to scroll to focused element

Sync

</>

Synchronization options for coordinating AJAX requests.

Controls how multiple requests to the same element are handled.

Official Sync Documentation

pub type Sync {
  Default(Selector)
  Drop(Selector)
  Abort(Selector)
  Replace(Selector)
  Queue(Selector, Queue)
}

Constructors

```
Default(Selector)
```
Use default behavior (drop new requests if one is in flight)
```
Drop(Selector)
```
Explicitly drop (ignore) new requests if one is in flight
```
Abort(Selector)
```
Drop new requests OR abort current request if a new one comes in
```
Replace(Selector)
```
Abort current request and replace it with the new one
```
Queue(Selector, Queue)
```
Queue requests with specified strategy

Values

blur

</>

pub fn blur() -> Event

Creates a blur event.

boost

</>

pub fn boost(set: Bool) -> attribute.Attribute(a)

Progressive enhancement for links and forms using AJAX.

change

</>

pub fn change() -> Event

Creates a change event (fires when an input value changes).

click

</>

pub fn click() -> Event

Creates a click event.

confirm

</>

pub fn confirm(confirm_text: String) -> attribute.Attribute(a)

Shows a confirmation dialog before making a request.

custom

</>

pub fn custom(event_name: String) -> Event

Creates a custom event with the given name.

delete

</>

pub fn delete(url url: String) -> attribute.Attribute(a)

Issues a DELETE request to the given URL when the element is triggered.

disable

</>

pub fn disable() -> attribute.Attribute(a)

Disables HTMX processing for an element and its children.

disable_elt

</>

pub fn disable_elt(
  extended_css_selectors: List(Selector),
) -> attribute.Attribute(a)

Disables elements during AJAX requests.

Examples

// Disable specific buttons
hx.disable_elt([hx.Selector("button")])

// Disable multiple element types
hx.disable_elt([
  hx.Selector("input[type='submit']"),
  hx.Selector("button")
])

disinherit

</>

pub fn disinherit(
  attributes: List(String),
) -> attribute.Attribute(a)

Controls which attributes are not inherited from parent elements.

disinherit_all

</>

pub fn disinherit_all() -> attribute.Attribute(a)

Prevents inheritance of all HTMX attributes from ancestors.

dom_content_loaded

</>

pub fn dom_content_loaded() -> Event

Creates a DOMContentLoaded event that fires when the initial HTML document is loaded.

encoding

</>

pub fn encoding(encoding: String) -> attribute.Attribute(a)

Sets the encoding type for the request (e.g., “multipart/form-data”).

ext

</>

pub fn ext(ext: List(String)) -> attribute.Attribute(a)

Enables HTMX extensions for an element.

focus

</>

pub fn focus() -> Event

Creates a focus event.

get

</>

pub fn get(url url: String) -> attribute.Attribute(a)

Issues a GET request to the given URL when the element is triggered.

headers

</>

pub fn headers(
  headers: json.Json,
  compute_value: Bool,
) -> attribute.Attribute(a)

Adds custom headers to the AJAX request.

history

</>

pub fn history(should_be_saved: Bool) -> attribute.Attribute(a)

Controls if requests from this element update browser history.

history_elt

</>

pub fn history_elt() -> attribute.Attribute(a)

Marks the element to snapshot for history restoration.

htmx_abort

</>

pub fn htmx_abort() -> Event

Listener event to cancel ongoing requests.

htmx_after_on_load

</>

pub fn htmx_after_on_load() -> Event

Triggered after an AJAX onload has finished.

htmx_after_process_node

</>

pub fn htmx_after_process_node() -> Event

Triggered after processing a DOM node.

htmx_after_request

</>

pub fn htmx_after_request() -> Event

Triggered after an AJAX request completes.

htmx_after_settle

</>

pub fn htmx_after_settle() -> Event

Triggered after the settling phase completes.

htmx_after_swap

</>

pub fn htmx_after_swap() -> Event

Triggered after content is swapped into the DOM.

htmx_bad_response_url

</>

pub fn htmx_bad_response_url() -> Event

Triggered when a bad response URL is encountered.

htmx_before_cleanup_element

</>

pub fn htmx_before_cleanup_element() -> Event

Triggered before cleaning up an element.

htmx_before_history_save

</>

pub fn htmx_before_history_save() -> Event

Triggered before a history save occurs.

htmx_before_history_update

</>

pub fn htmx_before_history_update() -> Event

Triggered before a history update occurs.

htmx_before_on_load

</>

pub fn htmx_before_on_load() -> Event

Triggered before any response processing.

htmx_before_process_node

</>

pub fn htmx_before_process_node() -> Event

Triggered before processing a DOM node.

htmx_before_request

</>

pub fn htmx_before_request() -> Event

Triggered before an AJAX request is made.

htmx_before_send

</>

pub fn htmx_before_send() -> Event

Triggered right before sending the request.

htmx_before_settle

</>

pub fn htmx_before_settle() -> Event

Triggered before the settling phase begins.

htmx_before_swap

</>

pub fn htmx_before_swap() -> Event

Triggered before content is swapped into the DOM.

htmx_before_transition

</>

pub fn htmx_before_transition() -> Event

Triggered before View Transition API wraps a swap.

htmx_config_request

</>

pub fn htmx_config_request() -> Event

Triggered before a request is configured.

htmx_confirm

</>

pub fn htmx_confirm() -> Event

Triggered before every request trigger, allowing cancellation or async confirmation.

htmx_error

</>

pub fn htmx_error() -> Event

Triggered on general errors.

htmx_eval_disallowed_error

</>

pub fn htmx_eval_disallowed_error() -> Event

Triggered when eval is disallowed.

htmx_event_filter_error

</>

pub fn htmx_event_filter_error() -> Event

Triggered when an event filter error occurs.

htmx_history_cache_error

</>

pub fn htmx_history_cache_error() -> Event

Triggered when a history cache error occurs.

htmx_history_cache_hit

</>

pub fn htmx_history_cache_hit() -> Event

Triggered when a history cache hit occurs.

htmx_history_cache_miss

</>

pub fn htmx_history_cache_miss() -> Event

Triggered when a history cache miss occurs.

htmx_history_cache_miss_load

</>

pub fn htmx_history_cache_miss_load() -> Event

Triggered when loading after a history cache miss.

htmx_history_cache_miss_load_error

</>

pub fn htmx_history_cache_miss_load_error() -> Event

Triggered when a history cache miss load error occurs.

htmx_history_item_created

</>

pub fn htmx_history_item_created() -> Event

Triggered when a history item is created.

htmx_history_restore

</>

pub fn htmx_history_restore() -> Event

Triggered when history is restored.

htmx_invalid_path

</>

pub fn htmx_invalid_path() -> Event

Triggered when an invalid path is encountered.

htmx_load

</>

pub fn htmx_load() -> Event

Triggered when new content is loaded into the DOM.

htmx_on_load_error

</>

pub fn htmx_on_load_error() -> Event

Triggered when an onload error occurs.

htmx_oob_after_swap

</>

pub fn htmx_oob_after_swap() -> Event

Triggered after an out-of-band swap.

htmx_oob_before_swap

</>

pub fn htmx_oob_before_swap() -> Event

Triggered before an out-of-band swap.

htmx_oob_error_no_target

</>

pub fn htmx_oob_error_no_target() -> Event

Triggered when an OOB swap target is not found.

htmx_prompt

</>

pub fn htmx_prompt() -> Event

Triggered when a prompt is shown.

htmx_pushed_into_history

</>

pub fn htmx_pushed_into_history() -> Event

Triggered when an element is pushed into history.

htmx_replaced_in_history

</>

pub fn htmx_replaced_in_history() -> Event

Triggered when an element is replaced in history.

htmx_response_error

</>

pub fn htmx_response_error() -> Event

Triggered when an HTTP error response is received.

htmx_restored

</>

pub fn htmx_restored() -> Event

Triggered when the page is restored from history.

htmx_send_abort

</>

pub fn htmx_send_abort() -> Event

Triggered when a request is aborted.

htmx_send_error

</>

pub fn htmx_send_error() -> Event

Triggered when a network error occurs.

htmx_session_storage_test

</>

pub fn htmx_session_storage_test() -> Event

Triggered during session storage test.

htmx_swap_error

</>

pub fn htmx_swap_error() -> Event

Triggered when an error occurs during swap.

htmx_syntax_error

</>

pub fn htmx_syntax_error() -> Event

Triggered when a syntax error occurs.

htmx_target_error

</>

pub fn htmx_target_error() -> Event

Triggered when a target error occurs.

htmx_timeout

</>

pub fn htmx_timeout() -> Event

Triggered when a request times out.

htmx_trigger

</>

pub fn htmx_trigger() -> Event

Triggered when a trigger is activated.

htmx_validate_url

</>

pub fn htmx_validate_url() -> Event

Validates the URL before making the request.

htmx_validation_failed

</>

pub fn htmx_validation_failed() -> Event

Triggered when validation fails.

htmx_validation_halted

</>

pub fn htmx_validation_halted() -> Event

Triggered when validation is halted.

htmx_validation_validate

</>

pub fn htmx_validation_validate() -> Event

Triggered before validation runs.

htmx_xhr_abort

</>

pub fn htmx_xhr_abort() -> Event

Triggered when an XHR request is aborted.

htmx_xhr_loadend

</>

pub fn htmx_xhr_loadend() -> Event

Triggered when an XHR request ends.

htmx_xhr_loadstart

</>

pub fn htmx_xhr_loadstart() -> Event

Triggered when an XHR request starts.

htmx_xhr_progress

</>

pub fn htmx_xhr_progress() -> Event

Triggered during XHR request progress.

Official Hyperscript Documentation

hyper_script

</>

pub fn hyper_script(script: String) -> attribute.Attribute(a)

Adds hyperscript behavior to an element using the “_” attribute.

include

</>

pub fn include(
  extended_css_selector: Selector,
) -> attribute.Attribute(a)

Includes additional element values in the request.

indicator

</>

pub fn indicator(selector: Selector) -> attribute.Attribute(a)

Shows loading indicators during AJAX requests.

Supports extended CSS selectors including closest, this, etc.

inherit

</>

pub fn inherit(
  attributes: List(String),
) -> attribute.Attribute(a)

Explicitly inherits specific attributes from parent elements.

inherit_all

</>

pub fn inherit_all() -> attribute.Attribute(a)

Inherits all HTMX attributes from parent elements.

input

</>

pub fn input() -> Event

Creates an input event (fires on every character typed).

Official Intersect Documentation

intersect

</>

pub fn intersect(config: List(IntersectConfig)) -> Event

Creates an intersect event that triggers when the element enters the viewport.

Supports configuration options for root element, threshold, and root margin.

Examples

// Basic intersect
hx.intersect([])

// With threshold
hx.intersect([hx.Threshold(0.5)])

// With root element and threshold
hx.intersect([hx.Root("#container"), hx.Threshold(0.75)])

intersect_once

</>

pub fn intersect_once(config: List(IntersectConfig)) -> Event

Creates an intersect event that fires only once when entering the viewport.

Official Intersect Documentation

Examples

// Basic intersect once
hx.intersect_once([])

// With threshold, fires once
hx.intersect_once([hx.Threshold(0.5)])

keydown

</>

pub fn keydown() -> Event

Creates a keydown event.

keyup

</>

pub fn keyup() -> Event

Creates a keyup event.

load

</>

pub fn load() -> Event

Creates a load event that fires when the element loads.

mouseout

</>

pub fn mouseout() -> Event

Creates a mouseout event.

mouseover

</>

pub fn mouseover() -> Event

Creates a mouseover event.

no_replace_url

</>

pub fn no_replace_url() -> attribute.Attribute(a)

Prevents URL replacement in the browser history.

on

</>

pub fn on(
  event_name: String,
  script: String,
) -> attribute.Attribute(a)

Handles events with inline scripts on elements using the hx-on attribute.

This is an HTMX 2.x feature that allows inline event handling.

Examples

hx.on("click", "alert('Clicked!')")
hx.on("htmx:afterSwap", "console.log('Swapped')")

params

</>

pub fn params(params: String) -> attribute.Attribute(a)

Filters which parameters are included in the request.

patch

</>

pub fn patch(url url: String) -> attribute.Attribute(a)

Issues a PATCH request to the given URL when the element is triggered.

post

</>

pub fn post(url url: String) -> attribute.Attribute(a)

Issues a POST request to the given URL when the element is triggered.

preserve

</>

pub fn preserve() -> attribute.Attribute(a)

Preserves element state between requests (e.g., iframes, videos).

prompt

</>

pub fn prompt(prompt_text: String) -> attribute.Attribute(a)

Shows an input prompt before submitting the request.

push_url

</>

pub fn push_url(bool: Bool) -> attribute.Attribute(a)

Pushes a URL into the browser’s location bar and history.

put

</>

pub fn put(url url: String) -> attribute.Attribute(a)

Issues a PUT request to the given URL when the element is triggered.

replace_url

</>

pub fn replace_url() -> attribute.Attribute(a)

Replaces the current URL in the browser history.

replace_url_with

</>

pub fn replace_url_with(url: String) -> attribute.Attribute(a)

Replaces the current URL with the specified URL.

request

</>

pub fn request(request: String) -> attribute.Attribute(a)

Configures the AJAX request (timeout, credentials, etc.).

resize

</>

pub fn resize() -> Event

Creates a resize event.

Official Revealed Documentation

revealed

</>

pub fn revealed() -> Event

Creates a revealed event that triggers when the element is scrolled into the viewport.

scroll

</>

pub fn scroll() -> Event

Creates a scroll event.

select

</>

pub fn select(css_selector: String) -> attribute.Attribute(a)

Selects a subset of the server response to process.

select_oob

</>

pub fn select_oob(
  css_selectors: List(String),
) -> attribute.Attribute(a)

Selects content from a response to be swapped in out-of-band.

Accepts a comma-separated list of CSS selectors for elements to swap out-of-band.

submit

</>

pub fn submit() -> Event

Creates a submit event (fires when a form is submitted).

swap

</>

pub fn swap(swap swap: Swap) -> attribute.Attribute(a)

Controls how content is swapped into the DOM.

Examples

// Basic swap strategies
hx.swap(hx.InnerHTML)
hx.swap(hx.OuterHTML)
hx.swap(hx.Afterend)

swap_oob

</>

pub fn swap_oob(
  swap swap: Swap,
  css_selector css_selector: option.Option(String),
) -> attribute.Attribute(a)

Allows you to swap content “out of band” - updating other elements in the response.

swap_oob_with

</>

pub fn swap_oob_with(
  swap swap: Swap,
  css_selector css_selector: option.Option(String),
  config modifier: SwapConfig,
) -> attribute.Attribute(a)

Allows you to swap content “out of band” with configuration options.

swap_with

</>

pub fn swap_with(
  swap swap: Swap,
  config config: SwapConfig,
) -> attribute.Attribute(a)

Controls how content is swapped into the DOM with additional configuration options.

Examples

// Swap with transition
hx.swap_with(hx.InnerHTML, hx.Transition(True))

// Swap with timing
hx.swap_with(hx.OuterHTML, hx.SwapTiming(duration.milliseconds(500)))

sync

</>

pub fn sync(strategy: Sync) -> attribute.Attribute(a)

Synchronizes AJAX requests between elements.

Examples

// Use default drop behavior (strategy is optional)
hx.sync(hx.Default(hx.Closest("form")))

// Explicitly drop conflicting requests
hx.sync(hx.Drop(hx.Closest("form")))

// Abort current request if new one comes in
hx.sync(hx.Abort(hx.This))

// Queue requests, keeping only the last
hx.sync(hx.Queue(hx.Selector("#form"), hx.Last))

sync_option_to_string

</>

pub fn sync_option_to_string(sync_option: Sync) -> String

target

</>

pub fn target(
  extended_css_selector extended_css_selector: Selector,
) -> attribute.Attribute(a)

Specifies the target element to swap content into.

Examples

// Target specific element
hx.target(hx.Selector("#results"))

// Target parent element
hx.target(hx.Closest(".card"))

// Target the element itself
hx.target(hx.This)

trigger

</>

pub fn trigger(events: List(Event)) -> attribute.Attribute(a)

Specifies which events will cause an HTMX request.

Examples

// Single event
hx.trigger([hx.click()])

// Multiple events
hx.trigger([hx.click(), hx.keyup()])

// Event with modifiers
hx.trigger([hx.with_delay(hx.click(), duration.seconds(2))])

trigger_polling

</>

pub fn trigger_polling(
  timing timing: duration.Duration,
  filters filters: option.Option(String),
  on_load on_load: Bool,
) -> attribute.Attribute(a)

Creates a polling trigger that fires at regular intervals.

Examples

// Poll every 5 seconds
hx.trigger_polling(timing: duration.seconds(5), filters: None, on_load: False)

// Poll with filters
hx.trigger_polling(timing: duration.seconds(10), filters: Some("visible"), on_load: False)

// Start polling immediately and on load
hx.trigger_polling(timing: duration.seconds(2), filters: None, on_load: True)

validate

</>

pub fn validate(bool: Bool) -> attribute.Attribute(a)

Forces validation before making a request.

vals

</>

pub fn vals(
  json: json.Json,
  compute_value: Bool,
) -> attribute.Attribute(a)

Adds values to be submitted with the request.

with_changed

</>

pub fn with_changed(event: Event) -> Event

Only triggers if the element’s value has changed.

with_consume

</>

pub fn with_consume(event: Event) -> Event

Prevents the event from bubbling up the DOM.

with_delay

</>

pub fn with_delay(
  event: Event,
  timing: duration.Duration,
) -> Event

Adds a delay before the event triggers.

with_from

</>

pub fn with_from(
  event: Event,
  extended_css_selector: Selector,
) -> Event

Listens for the event on a different element.

with_once

</>

pub fn with_once(event: Event) -> Event

Makes the event fire only once.

with_queue

</>

pub fn with_queue(
  event: Event,
  queue: option.Option(Queue),
) -> Event

Queues the event with a specific strategy.

with_target

</>

pub fn with_target(event: Event, css_selector: String) -> Event

Filters the event to only trigger when it targets a specific element.

with_throttle

</>

pub fn with_throttle(
  event: Event,
  timing: duration.Duration,
) -> Event

Throttles the event to fire at most once per duration.