Package io.github.wimdeblauwe.htmx.spring.boot.mvc

Enum Class HtmxRequestHeader

java.lang.Object

java.lang.Enum<HtmxRequestHeader>

io.github.wimdeblauwe.htmx.spring.boot.mvc.HtmxRequestHeader

All Implemented Interfaces:

Serializable, Comparable<HtmxRequestHeader>, Constable

public enum HtmxRequestHeader
extends Enum<HtmxRequestHeader>

Enum representing the request headers used by htmx.

See Also:

• Request Headers Reference

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HX_BOOSTED	Indicates that the request comes from an element that uses hx-boost.
HX_CURRENT_URL	The current URL of the browser
HX_HISTORY_RESTORE_REQUEST	Indicates if the request is for history restoration after a miss in the local history cache.
HX_PROMPT	Contains the user response to a hx-prompt.
HX_REQUEST	Only present and true if the request is issued by htmx.
HX_TARGET	The id of the target element if it exists.
HX_TRIGGER	The id of the triggered element if it exists.
HX_TRIGGER_NAME	The name of the triggered element if it exists

Method Summary

Modifier and Type	Method	Description
String	getValue()
static HtmxRequestHeader	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HtmxRequestHeader[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HX_BOOSTED

public static final HtmxRequestHeader HX_BOOSTED

Indicates that the request comes from an element that uses hx-boost.

See Also:

• HX-Boosted

HX_CURRENT_URL

public static final HtmxRequestHeader HX_CURRENT_URL

The current URL of the browser

See Also:

• HX-Current-URL

HX_HISTORY_RESTORE_REQUEST

public static final HtmxRequestHeader HX_HISTORY_RESTORE_REQUEST

Indicates if the request is for history restoration after a miss in the local history cache.

See Also:

• HX-History-Restore-Request

HX_PROMPT

public static final HtmxRequestHeader HX_PROMPT

Contains the user response to a hx-prompt.

See Also:

• HX-Prompt

HX_REQUEST

public static final HtmxRequestHeader HX_REQUEST

Only present and true if the request is issued by htmx.

See Also:

• HX-Request

HX_TARGET

public static final HtmxRequestHeader HX_TARGET

The id of the target element if it exists.

See Also:

• HX-Target

HX_TRIGGER_NAME

public static final HtmxRequestHeader HX_TRIGGER_NAME

The name of the triggered element if it exists

See Also:

• HX-Trigger-Name

HX_TRIGGER

public static final HtmxRequestHeader HX_TRIGGER

The id of the triggered element if it exists.

See Also:

• HX-Trigger

Method Details

values

public static HtmxRequestHeader[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HtmxRequestHeader valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()