htmltemplate

Documentation

Overview

Package htmltemplate provides an HTML renderer.

Index

• func Middleware(r Renderer) httpmiddleware.MiddlewareFunc
• func MustRender(w http.ResponseWriter, req *http.Request, name string, vars ...any)
• func Render(w http.ResponseWriter, req *http.Request, name string, vars ...any) error
• type Engine
  • func NewEngine(config *EngineConfig) Engine
• type EngineConfig
• type Renderer
  • func New(f fs.FS, e Engine) (Renderer, error)

Functions

func Middleware

func Middleware(r Renderer) httpmiddleware.MiddlewareFunc

Middleware

func MustRender

func MustRender(w http.ResponseWriter, req *http.Request, name string, vars ...any)

MustRender is like Render, but panics if an error occurs.

func Render

func Render(w http.ResponseWriter, req *http.Request, name string, vars ...any) error

Render renders an HTML template with the given name and variables.

Types

type Engine

type Engine interface {
	// ParseFS loads templates from the given fs.
	ParseFS(f fs.FS) error

	// Execute evaluates template with given name and the data context.
	Execute(w io.Writer, name string, data any) error
}

Engine is an adapter for a templating engine that is used by a Renderer.

func NewEngine

func NewEngine(config *EngineConfig) Engine

NewEngine creates a a new Engine backed by template/html.

type EngineConfig

type EngineConfig struct {
	Root      string
	Extension string
	Funcs     template.FuncMap
}

type Renderer

type Renderer interface {
	// Render renders a template with the given name and data.
	Render(w io.Writer, name string, data any) error
}

Renderer renders a template using provided underlying engine.

func New

func New(f fs.FS, e Engine) (Renderer, error)