htmx

Documentation

Index

• Constants
• type Request
  • func GetRequest(ctx echo.Context) Request
• type Response
  • func (r Response) Apply(ctx echo.Context)

Constants

const (
	HeaderBoosted               = "HX-Boosted"
	HeaderHistoryRestoreRequest = "HX-History-Restore-Request"
	HeaderPrompt                = "HX-Prompt"
	HeaderRequest               = "HX-Request"
	HeaderTarget                = "HX-Target"
	HeaderTrigger               = "HX-Trigger"
	HeaderTriggerName           = "HX-Trigger-Name"
)

Request headers: https://htmx.org/docs/#request-headers

const (
	HeaderPushURL            = "HX-Push-Url"
	HeaderRedirect           = "HX-Redirect"
	HeaderReplaceURL         = "HX-Replace-Url"
	HeaderRefresh            = "HX-Refresh"
	HeaderTriggerAfterSettle = "HX-Trigger-After-Settle"
	HeaderTriggerAfterSwap   = "HX-Trigger-After-Swap"
)

Response headers: https://htmx.org/docs/#response-headers

Types

type Request

type Request struct {
	Enabled        bool
	Boosted        bool
	HistoryRestore bool
	Trigger        string
	TriggerName    string
	Target         string
	Prompt         string
}

Request contains data that HTMX provides during requests

func GetRequest

func GetRequest(ctx echo.Context) Request

GetRequest extracts HTMX data from the request

type Response

type Response struct {
	PushURL            string
	Redirect           string
	Refresh            bool
	ReplaceURL         string
	Trigger            string
	TriggerAfterSwap   string
	TriggerAfterSettle string
	NoContent          bool
}

Response contain data that the server can communicate back to HTMX

func (Response) Apply

func (r Response) Apply(ctx echo.Context)

Apply applies data from a Response to a server response