render

Documentation

Index

• Variables
• func Middleware(templates fs.FS, options ...Option) func(http.Handler) http.Handler
• func TemplateFS(embed fs.FS, dir string) templatesFS
• type Engine
  • func EngineFromCtx(ctx context.Context) *Engine
  • func NewEngine(fs fs.FS, options ...Option) *Engine
  • func (e *Engine) HTML(w io.Writer) *Page
  • func (e *Engine) RenderHTML(template string, values map[string]any) (string, error)
  • func (e *Engine) Set(key string, value any)
  • func (e *Engine) SetHelper(key string, value any)
• type Option
  • func WithDefaultLayout(layout string) Option
  • func WithHelpers(hps map[string]any) Option
• type Page
  • func FromCtx(ctx context.Context) *Page
  • func (p *Page) Render(page string) error
  • func (p *Page) RenderClean(name string) error
  • func (p *Page) RenderWithLayout(page, layout string) error
  • func (p *Page) Set(key string, value any)
  • func (p *Page) Value(key string) any

Variables

var AllHelpers = hctx.Merge(
	content.New(),
	debug.New(),
	encoders.New(),
	env.New(),
	escapes.New(),
	iterators.New(),
	meta.New(),
	text.New(),
)

AllHelpers contains all of the default helpers for These will be available to all templates.

var InCtx = Middleware

InCtx puts the render engine in the context so the handlers can use it, it also sets a few other values that are useful for the handlers.

Functions

func Middleware

func Middleware(templates fs.FS, options ...Option) func(http.Handler) http.Handler

Middleware puts the render engine in the context so the handlers can use it, it also sets a few other values that are useful for the handlers.

func TemplateFS

func TemplateFS(embed fs.FS, dir string) templatesFS

NewFallbackFS returns a new FS that wraps the given directory and embedded FS. the embed.FS is expected to embed the same files as the directory FS.

Types

type Engine

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

func EngineFromCtx

func EngineFromCtx(ctx context.Context) *Engine

FromCtx returns the render engine from the context, it assumes the render render engine has been set by the render middleware.

func NewEngine

func NewEngine(fs fs.FS, options ...Option) *Engine

NewEngine builds the render engine based on the file system and the options passed to it.

func (*Engine) HTML

func (e *Engine) HTML(w io.Writer) *Page

func (*Engine) RenderHTML

func (e *Engine) RenderHTML(template string, values map[string]any) (string, error)

func (*Engine) Set

func (e *Engine) Set(key string, value any)

func (*Engine) SetHelper

func (e *Engine) SetHelper(key string, value any)

type Option

type Option func(*Engine)

func WithDefaultLayout

func WithDefaultLayout(layout string) Option

WithDefaultLayout sets the default layout for the engine if no layout is specified in the template this layout will be used. By default this is set to "app/layouts/application.html"

func WithHelpers

func WithHelpers(hps map[string]any) Option

WithHelpers sets the helpers for the engine these helpers will be available in all templates rendered by this engine.

type Page

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

func FromCtx

func FromCtx(ctx context.Context) *Page

FromCtx returns the render engine from the context when its called it also adds any value in the valuer into the page, this is useful for the middlewares such as session to add values to the page.

func (*Page) Render

func (p *Page) Render(page string) error

func (*Page) RenderClean

func (p *Page) RenderClean(name string) error

func (*Page) RenderWithLayout

func (p *Page) RenderWithLayout(page, layout string) error

func (*Page) Set

func (p *Page) Set(key string, value any)

func (*Page) Value

func (p *Page) Value(key string) any