template

README

server/template

Import path: github.com/InsideGallery/core/server/template

template wraps html/template parsing and execution for server-side HTML templates, including embedded filesystems.

Main APIs

• Options: explicit template name, directory, file list, and fs.FS.
• NewTemplateFromOptions(options): creates a template from explicit options.
• NewTemplateWithDir(name, dir, source, files...): parses files from an explicit base directory.
• NewTemplateBySource(source, name, pattern): parses an embedded template pattern.
• Template: named template wrapper.
• Engine: stores templates by name.
• Engine.Add, Exists, and Execute: template registry and rendering helpers.
• ErrExecuteTemplate and ErrNotFoundTemplate: execution sentinel errors.

GetDefaultTemplateDir, SetDefaultTemplateDir, and NewTemplate are deprecated environment-based helpers.

Usage

tmpl, err := coretemplate.NewTemplateWithDir("page.tmpl", "templates", fsys, "page.tmpl")
if err != nil {
	return err
}

engine := coretemplate.NewEngine()
engine.Add(tmpl)

html, err := engine.Execute("page.tmpl", map[string]string{"Name": "Ada"})

Operational Notes

Templates are configured with missingkey=error. Prefer explicit directory configuration through Options or NewTemplateWithDir instead of process-wide environment state.

Documentation

Overview

Package template provides server-side HTML template rendering helpers.

Prefer NewTemplateWithDir or NewTemplateFromOptions so template directory configuration is explicit.

Index

• Constants
• Variables
• func GetDefaultTemplateDir(prefix string) string
• func SetDefaultTemplateDir(prefix string, d string)
• type Engine
  • func NewEngine() *Engine
  • func (e *Engine) Add(t *Template)
  • func (e *Engine) Execute(name string, data interface{}) ([]byte, error)
  • func (e *Engine) Exists(name string) bool
• type Options
• type Template
  • func NewTemplate(name, prefix string, source fs.FS, files ...string) (*Template, error)
  • func NewTemplateBySource(source embed.FS, name, pattern string) (*Template, error)
  • func NewTemplateFromOptions(options Options) (*Template, error)
  • func NewTemplateWithDir(name, dir string, source fs.FS, files ...string) (*Template, error)

Constants

const DefaultTemplateDir = "DEFAULT_TEMPLATE_DIR"

DefaultTemplateDir have constant for template

Variables

var (
	ErrExecuteTemplate  = errors.New("error execute template")
	ErrNotFoundTemplate = errors.New("error not found template")
)

templates related errors

Functions

func GetDefaultTemplateDir

func GetDefaultTemplateDir(prefix string) string

GetDefaultTemplateDir return default template dir

Deprecated: pass the directory to NewTemplateWithDir or NewTemplateFromOptions.

func SetDefaultTemplateDir

func SetDefaultTemplateDir(prefix string, d string)

SetDefaultTemplateDir set default template dir

Deprecated: pass the directory to NewTemplateWithDir or NewTemplateFromOptions.

Types

type Engine

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

Engine type template engine

func NewEngine

func NewEngine() *Engine

NewEngine return engine

func (*Engine) Add

func (e *Engine) Add(t *Template)

Add add template

func (*Engine) Execute

func (e *Engine) Execute(name string, data interface{}) ([]byte, error)

Execute execute current template and return parsed strings

func (*Engine) Exists

func (e *Engine) Exists(name string) bool

Exists return true if page exists

type Options

type Options struct {
	Name  string
	Dir   string
	Files []string
	FS    fs.FS
}

Options configures template parsing without environment state.

type Template

type Template struct {
	*template.Template
	Name string
}

Template describe template

func NewTemplate

func NewTemplate(name, prefix string, source fs.FS, files ...string) (*Template, error)

NewTemplate return new template

Deprecated: use NewTemplateWithDir or NewTemplateFromOptions with explicit directory config.

func NewTemplateBySource

func NewTemplateBySource(source embed.FS, name, pattern string) (*Template, error)

NewTemplateBySource return new template bu source

func NewTemplateFromOptions

func NewTemplateFromOptions(options Options) (*Template, error)

NewTemplateFromOptions returns a new template from explicit options.

func NewTemplateWithDir

func NewTemplateWithDir(name, dir string, source fs.FS, files ...string) (*Template, error)

NewTemplateWithDir returns a new template using an explicit base directory.