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

Annotation Interface HxLocation

@Target({TYPE,METHOD})
@Retention(RUNTIME)
public @interface HxLocation

Annotation to do a client side redirect that does not do a full page reload.

Note that this annotation does not provide support for specifying values or headers. If you want to do this, use HtmxResponse instead.

See Also:

• HX-Location Response Header

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	contextRelative	If the path should be interpreted as context relative if it starts with a slash ("/").
String	event	An event that "triggered" the request
String	handler	A callback that will handle the response HTML.
String	path	The url path to make the redirect.
String	select	A CSS selector to select the content you want swapped from a response.
String	source	The source element of the request
String	swap	How the response will be swapped in relative to the target
String	target	The target to swap the response into.
String	value	The url path to make the redirect.

Element Details

value

@AliasFor("path")
String value

The url path to make the redirect.

This is an alias for path(). For example, @HxLocation("/foo") is equivalent to @HxLocation(path="/foo").

Default:

""

path

String path

The url path to make the redirect.

Default:

""

source

String source

The source element of the request

Default:

""

event

String event

An event that "triggered" the request

Default:

""

handler

String handler

A callback that will handle the response HTML.

Default:

""

target

String target

The target to swap the response into.

Default:

""

swap

String swap

How the response will be swapped in relative to the target

Default:

""

select

String select

A CSS selector to select the content you want swapped from a response.

Default:

""

contextRelative

boolean contextRelative

If the path should be interpreted as context relative if it starts with a slash ("/").

Default:

true