htmx

package
v0.38.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

Package htmx provides request detection and response header helpers for htmx.

All functions operate on standard net/http types with no framework dependency.

Index

Constants

View Source
const (
	HeaderRequest        = "HX-Request"
	HeaderBoosted        = "HX-Boosted"
	HeaderTrigger        = "HX-Trigger"
	HeaderTarget         = "HX-Target"
	HeaderCurrentURL     = "HX-Current-URL"
	HeaderPrompt         = "HX-Prompt"
	HeaderHistoryRestore = "HX-History-Restore-Request"
)

Request headers sent by htmx.

View Source
const (
	HeaderRedirect           = "HX-Redirect"
	HeaderTriggerResponse    = "HX-Trigger"
	HeaderTriggerAfterSettle = "HX-Trigger-After-Settle"
	HeaderTriggerAfterSwap   = "HX-Trigger-After-Swap"
	HeaderReswap             = "HX-Reswap"
	HeaderRetarget           = "HX-Retarget"
	HeaderRefresh            = "HX-Refresh"
	HeaderPushURL            = "HX-Push-Url"
	HeaderReplaceURL         = "HX-Replace-Url"
)

Response headers consumed by htmx.

Variables

This section is empty.

Functions

func GetTarget

func GetTarget(r *http.Request) string

GetTarget returns the HX-Target request header value.

func GetTrigger

func GetTrigger(r *http.Request) string

GetTrigger returns the HX-Trigger request header value.

func IsBoosted

func IsBoosted(r *http.Request) bool

IsBoosted reports whether the request is a boosted navigation.

func IsHTMX

func IsHTMX(r *http.Request) bool

IsHTMX reports whether the request was made by htmx.

func PushURL

func PushURL(w http.ResponseWriter, url string)

PushURL sets the HX-Push-Url response header.

func Redirect

func Redirect(w http.ResponseWriter, url string)

Redirect sets the HX-Redirect response header.

func Refresh

func Refresh(w http.ResponseWriter)

Refresh sets the HX-Refresh response header to "true".

func ReplaceURL

func ReplaceURL(w http.ResponseWriter, url string)

ReplaceURL sets the HX-Replace-Url response header.

func Reswap

func Reswap(w http.ResponseWriter, strategy string)

Reswap sets the HX-Reswap response header.

func Retarget

func Retarget(w http.ResponseWriter, selector string)

Retarget sets the HX-Retarget response header.

func Trigger

func Trigger(w http.ResponseWriter, events ...string)

Trigger sets the HX-Trigger response header with one or more events.

func TriggerAfterSettle

func TriggerAfterSettle(w http.ResponseWriter, events ...string)

TriggerAfterSettle sets the HX-Trigger-After-Settle response header.

func TriggerAfterSwap

func TriggerAfterSwap(w http.ResponseWriter, events ...string)

TriggerAfterSwap sets the HX-Trigger-After-Swap response header.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL