web

Documentation

Index

• func Register(jctx *lib.JournalistContext, fiberApp *fiber.App)
• type Engine
  • func New(directory, extension string) *Engine
  • func NewFileSystem(fs http.FileSystem, extension string) *Engine
  • func (e *Engine) AddFunc(name string, fn interface{}) *Engine
  • func (e *Engine) AddFuncMap(m map[string]interface{}) *Engine
  • func (e *Engine) Debug(enabled bool) *Engine
  • func (e *Engine) Delims(left, right string) *Engine
  • func (e *Engine) Layout(key string) *Engine
  • func (e *Engine) Load() error
  • func (e *Engine) Parse() error
  • func (e *Engine) Reload(enabled bool) *Engine
  • func (e *Engine) Render(out io.Writer, template string, binding interface{}, layout ...string) error

Functions

func Register

func Register(
	jctx *lib.JournalistContext,
	fiberApp *fiber.App,
)

Types

type Engine

type Engine struct {

	// templates
	Templates *template.Template
	// contains filtered or unexported fields
}

Engine struct

func New

func New(directory, extension string) *Engine

New returns a HTML render engine for Fiber

func NewFileSystem

func NewFileSystem(fs http.FileSystem, extension string) *Engine

NewFileSystem ...

func (*Engine) AddFunc

func (e *Engine) AddFunc(name string, fn interface{}) *Engine

AddFunc adds the function to the template's function map. It is legal to overwrite elements of the default actions

func (*Engine) AddFuncMap

func (e *Engine) AddFuncMap(m map[string]interface{}) *Engine

AddFuncMap adds the functions from a map to the template's function map. It is legal to overwrite elements of the default actions

func (*Engine) Debug

func (e *Engine) Debug(enabled bool) *Engine

Debug will print the parsed templates when Load is triggered.

func (*Engine) Delims

func (e *Engine) Delims(left, right string) *Engine

Delims sets the action delimiters to the specified strings, to be used in templates. An empty delimiter stands for the corresponding default: {{ or }}.

func (*Engine) Layout

func (e *Engine) Layout(key string) *Engine

Layout defines the variable name that will incapsulate the template

func (*Engine) Load

func (e *Engine) Load() error

Load parses the templates to the engine.

func (*Engine) Parse

func (e *Engine) Parse() error

Parse is deprecated, please use Load() instead

func (*Engine) Reload

func (e *Engine) Reload(enabled bool) *Engine

Reload if set to true the templates are reloading on each render, use it when you're in development and you don't want to restart the application when you edit a template file.

func (*Engine) Render

func (e *Engine) Render(out io.Writer, template string, binding interface{}, layout ...string) error

Render will execute the template name along with the given values.