ktor-htmx-html/io.ktor.htmx.html/HxAttributes

HxAttributes

class HxAttributes(val map: DelegatingMap) : StringMapDelegate(source)

Typed accessors for the HTMX (hx-*) attributes understood by the htmx.org client library.

Report a problem

Constructors

HxAttributes

constructor(map: DelegatingMap)

Types

@JvmInline

value class On(attributes: MutableMap<String, String>)

Typed access to the hx-on:* event handler attributes of a tag.

Properties

boost

var boost: Boolean?

Adds progressive enhancement for links and forms.

confirm

var confirm: String?

Shows a confirm() dialog before issuing a request.

delete

var delete: String?

Issues a DELETE to the specified URL.

disable

var disable: Boolean?

Disables htmx processing for the given node and any children nodes.

disabledElt

var disabledElt: String?

Adds the disabled attribute to the specified elements while a request is in flight.

disinherit

var disinherit: String?

Controls and disables automatic attribute inheritance for child nodes.

encoding

var encoding: String?

Changes the request encoding type.

ext

var ext: String?

Extensions to use for this element.

get

var get: String?

Issues a GET to the specified URL.

history

var history: String?

Prevents sensitive data from being saved to the history cache.

historyElt

var historyElt: String?

Specifies the element to snapshot and restore during history navigation.

include

var include: String?

Includes additional data in requests.

indicator

var indicator: String?

Specifies the element to put the htmx-request class on during the request.

inherit

var inherit: String?

Controls and enables automatic attribute inheritance for child nodes if it has been disabled by default.

map

open override val map: DelegatingMap

val on: HxAttributes.On

Provides typed access to the hx-on:* event handler attributes of this tag.

params

var params: String?

Filters the parameters that will be submitted with a request.

patch

var patch: String?

Issues a PATCH to the specified URL.

post

var post: String?

Issues a POST to the specified URL.

preserve

var preserve: Boolean?

Specifies elements to keep unchanged between requests.

prompt

var prompt: String?

Shows a prompt() before submitting a request.

pushUrl

var pushUrl: String?

Pushes a URL into the browser location bar to create history.

put

var put: String?

Issues a PUT to the specified URL.

replaceUrl

var replaceUrl: String?

Replaces the URL in the browser location bar.

request

var request: String?

Configures various aspects of the request.

select

var select: String?

Selects content to swap in from a response.

selectOob

var selectOob: String?

Selects content to swap in from a response, somewhere other than the target (out of band).

swap

var swap: String?

Controls how content will swap in (outerHTML, beforeend, afterend, …).

swapOob

var swapOob: String?

Marks element to swap in from a response (out of band).

sync

var sync: String?

Controls how requests made by different elements are synchronized.

target

var target: String?

Specifies the target element to be swapped.

trigger

var trigger: String?

Specifies the event that triggers the request.

validate

var validate: Boolean?

Forces elements to validate themselves before a request.

vals

var vals: String?

Adds values to submit with the request (JSON format).

vars

var vars: String?

Adds values dynamically to the parameters to submit with the request (deprecated, please use hx-vals).

Functions

get

open operator override fun get(key: String): String?

fun on(event: String, script: String)

Handles the given event with the inline script on this tag.

remove

open override fun remove(key: String): String?

set

open operator override fun set(key: String, value: String)

HxAttributes

See also

Constructors

Types

Properties

Functions