htmx¶

Serves the htmx JavaScript library as a static asset and provides Go helpers for htmx request detection and response headers. Inspired by django-htmx.

Package: github.com/oliverandrich/burrow/contrib/htmx

Depends on: staticfiles

Setup¶

srv := burrow.NewServer(
    htmx.New(),
    staticApp, // staticfiles.New(myStaticFS) — returns (*App, error)
    // ... other apps
)

The htmx app embeds htmx.min.js and serves it via the staticfiles app under the "htmx" prefix. Include it in your layout template:

<script src="{{ staticURL "htmx/htmx.min.js" }}" defer></script>

Request Detection¶

Parse htmx-specific request headers with htmx.Request():

import "github.com/oliverandrich/burrow/contrib/htmx"

func (h *Handlers) List(w http.ResponseWriter, r *http.Request) error {
    hx := htmx.Request(r)

    if hx.IsHTMX() {
        // Partial response — just the fragment
        return burrow.RenderTemplate(w, r, http.StatusOK, "notes/list-fragment", data)
    }

    // Full page response
    return burrow.RenderTemplate(w, r, http.StatusOK, "notes/list", data)
}

Automatic layout detection

burrow.RenderTemplate() already skips layout wrapping when it detects an HX-Request header. You typically don't need to check hx.IsHTMX() manually unless you want to return completely different content for htmx requests.

Available Request Methods¶

Method	Header	Description
`IsHTMX()`	`HX-Request`	Request was made by htmx
`IsBoosted()`	`HX-Boosted`	Request is via an `hx-boost` element
`Target()`	`HX-Target`	ID of the target element
`Trigger()`	`HX-Trigger`	ID of the triggered element
`TriggerName()`	`HX-Trigger-Name`	Name of the triggered element
`Prompt()`	`HX-Prompt`	User response to `hx-prompt`
`CurrentURL()`	`HX-Current-URL`	Current browser URL
`HistoryRestore()`	`HX-History-Restore-Request`	History restoration after cache miss

Response Helpers¶

Set htmx response headers to control client-side behaviour:

import "github.com/oliverandrich/burrow/contrib/htmx"

func (h *Handlers) Delete(w http.ResponseWriter, r *http.Request) error {
    // ... delete resource ...

    // Redirect the browser (client-side, no full page reload)
    htmx.Redirect(w, "/notes")
    return nil
}

Available Response Functions¶

Function	Header	Description
`Redirect(w, url)`	`HX-Redirect`	Client-side redirect
`Refresh(w)`	`HX-Refresh`	Full page refresh
`Trigger(w, event)`	`HX-Trigger`	Trigger a client-side event
`TriggerAfterSettle(w, event)`	`HX-Trigger-After-Settle`	Trigger event after settle
`TriggerAfterSwap(w, event)`	`HX-Trigger-After-Swap`	Trigger event after swap
`PushURL(w, url)`	`HX-Push-Url`	Push URL to history stack
`ReplaceURL(w, url)`	`HX-Replace-Url`	Replace current URL
`Reswap(w, strategy)`	`HX-Reswap`	Override swap strategy
`Retarget(w, selector)`	`HX-Retarget`	Change target element
`Location(w, url)`	`HX-Location`	Navigate without full reload

Interfaces Implemented¶

Interface	Description
`burrow.App`	Required: `Name()`, `Register()`
`HasStaticFiles`	Contributes embedded `htmx.min.js` under `"htmx"` prefix
`HasDependencies`	Requires `staticfiles`