blip

README

blip

blip is the bridge between Go web applications and htmx.

Note: blip is experimental software under active development. Use at your own risk.

Installing

$ go get -u git.sr.ht/~wtfiscrq/blip

Documentation

Documentation is available in pkg.go.dev.

Examples

Check the examples directory.

License

Blip is released under the MIT License.

---

HTML is dead, long live HTML! -- many speculated

Documentation

Index

• func ContextWithData(ctx context.Context, data any) context.Context
• func DataFromContext(ctx context.Context) any
• func SetData(r *http.Request, data any)
• type App
  • func New(opts ...Option) *App
  • func (app *App) Route(pattern string, tmplName string, handler http.Handler) *App
  • func (app *App) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Option
  • func WithRenderer(r renderer.Renderer) Option
  • func WithRouter(r router.Router) Option

Functions

func ContextWithData

func ContextWithData(ctx context.Context, data any) context.Context

func DataFromContext

func DataFromContext(ctx context.Context) any

func SetData

func SetData(r *http.Request, data any)

SetData is a convenience function that modifies an http.Request context to include the specified data. Use DataFromContext to retrieve the data.

Types

type App

type App struct {
	// contains filtered or unexported fields
}

App implements http.Handler and is responsible for handling and rendering pages and fragments.

func New

func New(opts ...Option) *App

New creates a new instance of App.

Uses http.ServeMux as the default router and template.Template as the default renderer. Different implenentations can be specified using WithRouter and WithRenderer option functions.

func (*App) Route

func (app *App) Route(pattern string, tmplName string, handler http.Handler) *App

func (*App) ServeHTTP

func (app *App) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Option

type Option func(*App)

func WithRenderer

func WithRenderer(r renderer.Renderer) Option

WithRenderer sets the default application renderer.Renderer.

func WithRouter

func WithRouter(r router.Router) Option

WithRouter sets the application router.Router.