ktor-htmx/io.ktor.htmx/HxEvents

HxEvents

object HxEvents(source)

Constants for HTMX events.

Report a problem

Properties

Abort

const val Abort: String

Send this event to an element to abort a request.

AfterOnLoad

const val AfterOnLoad: String

Triggered after an AJAX request has completed processing a successful response.

AfterProcessNode

const val AfterProcessNode: String

Triggered after htmx has initialized a node.

AfterRequest

const val AfterRequest: String

Triggered after an AJAX request has completed.

AfterSettle

const val AfterSettle: String

Triggered after the DOM has settled.

AfterSwap

const val AfterSwap: String

Triggered after new content has been swapped in.

BeforeCleanupElement

const val BeforeCleanupElement: String

Triggered before htmx disables an element or removes it from the DOM.

BeforeHistorySave

const val BeforeHistorySave: String

Triggered before content is saved to the history cache.

BeforeOnLoad

const val BeforeOnLoad: String

Triggered before any response processing occurs.

BeforeProcessNode

const val BeforeProcessNode: String

Triggered before htmx initializes a node.

BeforeRequest

const val BeforeRequest: String

Triggered before an AJAX request is made.

BeforeSend

const val BeforeSend: String

Triggered just before an AJAX request is sent.

BeforeSwap

const val BeforeSwap: String

Triggered before a swap is done, allows you to configure the swap.

ConfigRequest

const val ConfigRequest: String

Triggered before the request, allows you to customize parameters, headers.

Confirm

const val Confirm: String

Triggered after a trigger occurs on an element, allows you to cancel (or delay) issuing the AJAX request.

HistoryCacheError

const val HistoryCacheError: String

Triggered on an error during cache writing.

HistoryCacheMiss

const val HistoryCacheMiss: String

Triggered on a cache miss in the history subsystem.

HistoryCacheMissError

const val HistoryCacheMissError: String

Triggered on an unsuccessful remote retrieval.

HistoryCacheMissLoad

const val HistoryCacheMissLoad: String

Triggered on a successful remote retrieval.

HistoryRestore

const val HistoryRestore: String

Triggered when htmx handles a history restoration action.

Load

const val Load: String

Triggered when new content is added to the DOM.

NoSseSourceError

const val NoSseSourceError: String

Triggered when an element refers to a SSE event in its trigger, but no parent SSE source has been defined.

OnLoadError

const val OnLoadError: String

Triggered when an exception occurs during the onLoad handling in htmx.

OobAfterSwap

const val OobAfterSwap: String

Triggered after an out of band element has been swapped in.

OobBeforeSwap

const val OobBeforeSwap: String

Triggered before an out of band element swap is done, allows you to configure the swap.

OobErrorNoTarget

const val OobErrorNoTarget: String

Triggered when an out of band element does not have a matching ID in the current DOM.

Prompt

const val Prompt: String

Triggered after a prompt is shown.

PushedIntoHistory

const val PushedIntoHistory: String

Triggered after a URL is pushed into history.

ResponseError

const val ResponseError: String

Triggered when an HTTP response error (non-200 or 300 response code) occurs.

SendError

const val SendError: String

Triggered when a network error prevents an HTTP request from happening.

SseError

const val SseError: String

Triggered when an error occurs with a SSE source.

SseOpen

const val SseOpen: String

Triggered when a SSE source is opened.

SwapError

const val SwapError: String

Triggered when an error occurs during the swap phase.

TargetError

const val TargetError: String

Triggered when an invalid target is specified.

Timeout

const val Timeout: String

Triggered when a request timeout occurs.

ValidationFailed

const val ValidationFailed: String

Triggered when an element fails validation.

ValidationHalted

const val ValidationHalted: String

Triggered when a request is halted due to validation errors.

ValidationValidate

const val ValidationValidate: String

Triggered before an element is validated.

XhrAbort

const val XhrAbort: String

Triggered when an AJAX request aborts.

XhrLoadend

const val XhrLoadend: String

Triggered when an AJAX request ends.

XhrLoadstart

const val XhrLoadstart: String

Triggered when an AJAX request starts.

XhrProgress

const val XhrProgress: String

Triggered periodically during an AJAX request that supports progress events.

HxEvents

See also

Properties