autoroute

README

autoroute

file-based routing for golang + gin + templ

Documentation

Index

• Constants
• Variables
• type Context
  • func Ctx(ctx context.Context) *Context
  • func NewWrap(ginctx *gin.Context, url, partial, funcname string) *Context
  • func (c *Context) Href() string
  • func (c *Context) HrefPartial(partial string) string
  • func (c *Context) ParamInt32(key string) (int32, error)
  • func (c *Context) ParamInt64(key string) (int64, error)
  • func (c *Context) RequestIsBoosted() bool
  • func (c *Context) RequestIsEnabled() bool
  • func (c *Context) RequestPath() string
  • func (c *Context) RequestPrompt() string
  • func (c *Context) RequestTarget() string
  • func (c *Context) RequestTrigger() string
  • func (c *Context) RequestTriggerName() string
  • func (c *Context) ResponseError(status int, err error)
  • func (c *Context) ResponsePush(push string)
  • func (c *Context) ResponseRedirect(path string)
  • func (c *Context) ResponseRefresh(refresh bool)
  • func (c *Context) ResponseTrigger(trigger string)
  • func (c *Context) ResponseTriggerAfterSettle(trigger string)
  • func (c *Context) ResponseTriggerAfterSwap(trigger string)
  • func (c *Context) Templ(status int, component templ.Component)
• type HTMLTemplRenderer
  • func (r *HTMLTemplRenderer) Instance(s string, d any) render.Render
• type Renderer
  • func NewRenderer(ctx context.Context, status int, component templ.Component) *Renderer
  • func (t Renderer) Render(w http.ResponseWriter) error
  • func (t Renderer) WriteContentType(w http.ResponseWriter)
• type Response
• type Route

Constants

const (
	HeaderRequest            = "HX-Request"
	HeaderBoosted            = "HX-Boosted"
	HeaderTrigger            = "HX-Trigger"
	HeaderTriggerName        = "HX-Trigger-Name"
	HeaderTriggerAfterSwap   = "HX-Trigger-After-Swap"
	HeaderTriggerAfterSettle = "HX-Trigger-After-Settle"
	HeaderTarget             = "HX-Target"
	HeaderPrompt             = "HX-Prompt"
	HeaderPush               = "HX-Push"
	HeaderRedirect           = "HX-Redirect"
	HeaderRefresh            = "HX-Refresh"
)

Variables

var Default = &HTMLTemplRenderer{}

Types

type Context

type Context struct {
	*gin.Context
	Url      string
	Partial  string
	Funcname string
}

func Ctx

func Ctx(ctx context.Context) *Context

func NewWrap

func NewWrap(ginctx *gin.Context, url, partial, funcname string) *Context

func (*Context) Href

func (c *Context) Href() string

func (*Context) HrefPartial

func (c *Context) HrefPartial(partial string) string

func (*Context) ParamInt32

func (c *Context) ParamInt32(key string) (int32, error)

func (*Context) ParamInt64

func (c *Context) ParamInt64(key string) (int64, error)

func (*Context) RequestIsBoosted

func (c *Context) RequestIsBoosted() bool

func (*Context) RequestIsEnabled

func (c *Context) RequestIsEnabled() bool

func (*Context) RequestPath

func (c *Context) RequestPath() string

func (*Context) RequestPrompt

func (c *Context) RequestPrompt() string

func (*Context) RequestTarget

func (c *Context) RequestTarget() string

func (*Context) RequestTrigger

func (c *Context) RequestTrigger() string

func (*Context) RequestTriggerName

func (c *Context) RequestTriggerName() string

func (*Context) ResponseError

func (c *Context) ResponseError(status int, err error)

func (*Context) ResponsePush

func (c *Context) ResponsePush(push string)

func (*Context) ResponseRedirect

func (c *Context) ResponseRedirect(path string)

func (*Context) ResponseRefresh

func (c *Context) ResponseRefresh(refresh bool)

func (*Context) ResponseTrigger

func (c *Context) ResponseTrigger(trigger string)

func (*Context) ResponseTriggerAfterSettle

func (c *Context) ResponseTriggerAfterSettle(trigger string)

func (*Context) ResponseTriggerAfterSwap

func (c *Context) ResponseTriggerAfterSwap(trigger string)

func (*Context) Templ

func (c *Context) Templ(status int, component templ.Component)

type HTMLTemplRenderer

type HTMLTemplRenderer struct {
	FallbackHtmlRenderer render.HTMLRender
}

func (*HTMLTemplRenderer) Instance

func (r *HTMLTemplRenderer) Instance(s string, d any) render.Render

type Renderer

type Renderer struct {
	Ctx       context.Context
	Status    int
	Component templ.Component
}

func NewRenderer

func NewRenderer(ctx context.Context, status int, component templ.Component) *Renderer

func (Renderer) Render

func (t Renderer) Render(w http.ResponseWriter) error

func (Renderer) WriteContentType

func (t Renderer) WriteContentType(w http.ResponseWriter)

type Response

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

Response contain data that the server can communicate back to HTMX

type Route

type Route struct {
	UrlPath string
	Package string
	Method  string
}