view

Documentation

Index

• type FSRenderer
  • func NewFSRenderer(fs fs.FS) *FSRenderer
  • func (r *FSRenderer) Render(w io.Writer, name string, data any) error
• type MemRenderer
  • func NewMemRenderer(viewFS fs.FS) (*MemRenderer, error)
  • func (r *MemRenderer) Render(w io.Writer, name string, data any) error
• type View
  • func Parse(viewFS fs.FS, name string) (*View, error)
  • func (v *View) Render(w io.Writer, data any) error

Types

type FSRenderer

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

FSRenderer renders views from a file system.

func NewFSRenderer

func NewFSRenderer(fs fs.FS) *FSRenderer

NewFSRenderer returns a new FSRenderer.

func (*FSRenderer) Render

func (r *FSRenderer) Render(w io.Writer, name string, data any) error

type MemRenderer

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

MemRenderer renders views from memory.

func NewMemRenderer

func NewMemRenderer(viewFS fs.FS) (*MemRenderer, error)

NewMemRenderer parses all the views in the given fs and stores the results in memory.

func (*MemRenderer) Render

func (r *MemRenderer) Render(w io.Writer, name string, data any) error

type View

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

View is a collection of templates used to render data. Every view has an unique name.

A view combines the following templates to render a HTML page: - base.html (required) - {name}.html (optional) - partials/*.html (optional)

func Parse

func Parse(viewFS fs.FS, name string) (*View, error)

Parse parses the file system and returns a view for the given name. fs is expected to contain the specified view files in the root directory.

func (*View) Render

func (v *View) Render(w io.Writer, data any) error

Renders data using the view and writes the result to w.