Template Engine

A template engine renders content to the ResponseWriter.

A template engine plugin must include, at a minimum, the code below with the TemplateEngine() function. Notice the *ambient.PluginBase object is not included in the struct because this plugin type does need it.

// Package mvp provides a template for building a plugin for Ambient apps.
package mvp

import (
    "github.com/ambientkit/ambient"
)

// Plugin represents an Ambient plugin.
type Plugin struct{}

// New returns a new mvp plugin.
func New() *Plugin {
    return &Plugin{}
}

// PluginName returns the plugin name.
func (p *Plugin) PluginName() string {
    return "mvp"
}

// PluginVersion returns the plugin version.
func (p *Plugin) PluginVersion() string {
    return "1.0.0"
}

// TemplateEngine returns a template engine.
func (p *Plugin) TemplateEngine(logger ambient.Logger, injector ambient.AssetInjector) (ambient.Renderer, error) {
    // Your code here.
    return nil, nil
}

The function should take in both the Logger and AssetInjector.

ambient_injector.go

// AssetInjector represents code that can inject files into a template.
type AssetInjector interface {
    Inject(injector LayoutInjector, t *template.Template, r *http.Request,
        layoutType LayoutType, vars map[string]interface{}) (*template.Template, error)
    DebugTemplates() bool
    EscapeTemplates() bool
}

The function should return an object that satisfies the Renderer interface. The page and post allow you to define two different formats when rendering content so you can have the assets affect each differently.

ambient_renderer.go

// Renderer represents a template renderer.
type Renderer interface {
    Page(w http.ResponseWriter, r *http.Request, assets embed.FS, templateName string,
        fm template.FuncMap, vars map[string]interface{}) (err error)
    PageContent(w http.ResponseWriter, r *http.Request, content string,
        fm template.FuncMap, vars map[string]interface{}) (err error)
    Post(w http.ResponseWriter, r *http.Request, assets embed.FS, templateName string,
        fm template.FuncMap, vars map[string]interface{}) (err error)
    PostContent(w http.ResponseWriter, r *http.Request, content string,
        fm template.FuncMap, vars map[string]interface{}) (err error)
    Error(w http.ResponseWriter, r *http.Request, content string, statusCode int,
        fm template.FuncMap, vars map[string]interface{}) (err error)
}