README
¶
go-tmplbox
Yet Another (text|html)/template wrapper
WARNING
This repository has been moved to github.com/lestrrat-go/tmplbox. This repository exists so that libraries pointing to this URL will keep functioning, but this repository will NOT be updated in the future. Please use the new import path.
SYNOPSIS
<!-- base.html -->
{{ define "root" }}
<html>
<body>
{{ block "content" }}{{ end }}
</body>
</html>
{{ end }}
<!-- index.html -->
{{ define "content" }}Hello, World!{{ end }}
// assuming you're using go-bindata's Asset function to
// retrieve template sources here.
var box := tmplbox.New(tmplbox.AssetSourceFunc(Asset))
func indexHandler(w http.ResponseWriter, r *http.Response) {
// Assuming you have a dependency between index.html and
// base.html (see above), GetOrCompose will automatically
// compile and merge all of the specified templates.
t, _ := box.GetOrCompose("index.html", "base.html")
// Will output
// <!-- base.html -->
// <html>
// <body>
// Hello, World!
// </body>
// </html>
t.ExecuteTemplate(w, "root", nil)
}
FEATURES
- Plays well with go-bindata
- Easy to setup template dependency to emulate "extends", without another big library
Documentation
¶
Index ¶
- type AssetSource
- type AssetSourceFunc
- type Box
- func (b *Box) Compile(name string) (Template, error)
- func (b *Box) Compose(name string, deps ...string) (Template, error)
- func (b *Box) Funcs(fm FuncMap) *Box
- func (b *Box) Get(name string) (Template, error)
- func (b *Box) GetOrCompose(name string, deps ...string) (Template, error)
- func (b *Box) Set(name string, t Template) error
- type FuncMap
- type Template
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssetSource ¶
type AssetSourceFunc ¶
type Box ¶
type Box struct {
// contains filtered or unexported fields
}
func New ¶
func New(assets AssetSource) *Box
func (*Box) Compile ¶
Compile compiles the template specified the given name. If the template name has a ".html" suffix, html/template is used. Otherwise text/template is assumed.
func (*Box) Compose ¶
Compose creates a template instance using the templates specified in `name` and `deps`.
func (*Box) Funcs ¶
Funcs specifies the set of template functions that will be applied to all templates that are compiled
func (*Box) Get ¶
Get returns the template associated with asset `name`. An error is returned if the template does not exist.
func (*Box) GetOrCompose ¶
GetOrCompose is like Get, except that if the template named by `name` does not exist already, it will call Compose to generate it. Otherwise this methods turns a previously cached copy.
Source Files