add initial swap and trigger draft

Author: donseba

README.md

@@ -1,5 +1,5 @@
 # go-htmx
-unobstructive HTMX integration in golang applications.
+Seamless HTMX integration in golang applications.
 
 This package consists of two main parts, 
 1) Middleware to catch the HTMX headers from the request
@@ -8,7 +8,7 @@ This package consists of two main parts,
 # Getting started
 `go get github.com/donseba/go-htmx`
 
-initialise the htmx service like so : 
+initialize the htmx service like so : 
 ```go
 package main
 
@@ -47,11 +47,18 @@ func (a *App) Home(w http.ResponseWriter, r *http.Request) {
 	h.ReTarget("#ReTarged")
 
 	// write the output like you normally do.
-	// check inspector tool in browser to see that the headers are set.
+	// check the inspector tool in the browser to see that the headers are set.
 	_, _ = h.Write([]byte("OK"))
 }
 ```
 
+### Swapping
+Swapping is a way to replace the content of a dom element with the content of the response.
+This is done by setting the `HX-Swap` header to the id of the dom element you want to swap.
+
+### Trigger Events 
+Trigger events are a way to trigger events on the dom element.
+This is done by setting the `HX-Trigger` header to the event you want to trigger.
 
 echo middleware example: 
 ```go

handler.go

@@ -18,6 +18,16 @@ const (
 	StatusStopPolling = 286
 )
 
+// IsHxRequest returns true if the request is an htmx request
+func (h *Handler) IsHxRequest() bool {
+	return h.request.HxRequest
+}
+
+// IsHxBoosted returns true if the request is an htmx request and the request is boosted
+func (h *Handler) IsHxBoosted() bool {
+	return h.request.HxBoosted
+}
+
 // Write writes the data to the connection as part of an HTTP reply.
 func (h *Handler) Write(data []byte) (n int, err error) {
 	return h.w.Write(data)
@@ -89,6 +99,12 @@ func (h *Handler) ReSwap(val string) {
 	h.response.Set(HXReswap, val)
 }
 
+// ReSwapWithObject allows you to specify how the response will be swapped. See hx-swap for possible values
+// https://htmx.org/attributes/hx-swap/
+func (h *Handler) ReSwapWithObject(s *Swap) {
+	h.ReSwap(s.String())
+}
+
 // ReTarget a CSS selector that updates the target of the content update to a different element on the page
 func (h *Handler) ReTarget(val string) {
 	h.response.Set(HXRetarget, val)
@@ -105,18 +121,36 @@ func (h *Handler) Trigger(val string) {
 	h.response.Set(HXTrigger, val)
 }
 
+// TriggerWithObject triggers events as soon as the response is received.
+// https://htmx.org/headers/hx-trigger/
+func (h *Handler) TriggerWithObject(t *Trigger) {
+	h.Trigger(t.String())
+}
+
 // TriggerAfterSettle trigger events after the settling step.
 // https://htmx.org/headers/hx-trigger/
 func (h *Handler) TriggerAfterSettle(val string) {
 	h.response.Set(HXTriggerAfterSettle, val)
 }
 
+// TriggerAfterSettleWithObject trigger events after the settling step.
+// https://htmx.org/headers/hx-trigger/
+func (h *Handler) TriggerAfterSettleWithObject(t *Trigger) {
+	h.TriggerAfterSettle(t.String())
+}
+
 // TriggerAfterSwap trigger events after the swap step.
 // https://htmx.org/headers/hx-trigger/
 func (h *Handler) TriggerAfterSwap(val string) {
 	h.response.Set(HXTriggerAfterSwap, val)
 }
 
+// TriggerAfterSwapWithObject trigger events after the swap step.
+// https://htmx.org/headers/hx-trigger/
+func (h *Handler) TriggerAfterSwapWithObject(t *Trigger) {
+	h.TriggerAfterSwap(t.String())
+}
+
 // Request returns the HxHeaders from the request
 func (h *Handler) Request() HxRequestHeader {
 	return h.request

htmx.go

@@ -3,6 +3,12 @@ package htmx
 import (
 	"net/http"
 	"strings"
+	"time"
+)
+
+var (
+	DefaultSwapDuration = time.Duration(0 * time.Millisecond)
+	DefaultSettleDelay  = time.Duration(20 * time.Millisecond)
 )
 
 type (
@@ -13,11 +19,11 @@ func New() *HTMX {
 	return &HTMX{}
 }
 
-func (s *HTMX) NewHandler(w http.ResponseWriter, r *http.Request) *Handler {
+func (h *HTMX) NewHandler(w http.ResponseWriter, r *http.Request) *Handler {
 	return &Handler{
 		w:       w,
 		r:       r,
-		request: s.HxHeader(r.Context()),
+		request: h.HxHeader(r.Context()),
 		response: &HxResponseHeader{
 			headers: w.Header(),
 		},

request.go

@@ -19,7 +19,7 @@ type (
 	}
 )
 
-func (s *HTMX) HxHeader(ctx context.Context) HxRequestHeader {
+func (h *HTMX) HxHeader(ctx context.Context) HxRequestHeader {
 	header := ctx.Value(ContextRequestHeader)
 
 	if val, ok := header.(HxRequestHeader); ok {

suite/suite_test.go

@@ -6,6 +6,7 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"testing"
+	"time"
 
 	"github.com/donseba/go-htmx"
 	"github.com/donseba/go-htmx/middleware"
@@ -134,3 +135,31 @@ func TestStopPolling(t *testing.T) {
 
 	assert.Equal(t, htmx.StatusStopPolling, resp.StatusCode)
 }
+
+func TestSwap(t *testing.T) {
+	h := htmx.New()
+
+	svr := httptest.NewServer(middleware.MiddleWare(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		handler := h.NewHandler(w, r)
+
+		_ = handler.Location(location)
+		handler.ReSwapWithObject(htmx.NewSwap().ScrollTop().Settle(1 * time.Second))
+
+		_, err := handler.Write([]byte("hi"))
+		if err != nil {
+			t.Error(err)
+		}
+	})))
+	defer svr.Close()
+
+	resp, err := http.Get(svr.URL)
+	if err != nil {
+		t.Error("an error occurred while making the request")
+		return
+	}
+	defer resp.Body.Close()
+
+	t.Log(resp.Header.Get(htmx.HXReswap.String()))
+
+	assert.Equal(t, "innerHTML scroll:top settle:1s", resp.Header.Get(htmx.HXReswap.String()))
+}