View Renderer
A simple view renderer based on the html/template, but much simpler to use. Support layout rendering, including templates.
Features
- simple to use
- support loading multiple directories, multiple files
- support rendering string templates, etc.
- support layout render.
- eg
{{ include "header" }} {{ yield }} {{ include "footer" }}
- eg
- support include other templates. eg
{{ include "other" }} - built-in some helper methods
row,lower,upper,join...
Godoc
Quick Start
package main
import (
"bytes"
"fmt"
"github.com/gookit/view"
)
func main() {
// equals to call: view.NewRenderer() + r.MustInitialize()
r := view.NewInitialized(func(r *view.Renderer) {
// setting default layout
r.Layout = "layout" // equals to "layout.tpl"
// templates dir. will auto load on init.
r.ViewsDir = "testdata"
// add template function
r.AddFunc("myFunc", func() string {
return "my-func"
})
})
// fmt.Println(r.TemplateNames(true))
bf := new(bytes.Buffer)
// render template string
r.String(bf, `hello {{.}}`, "tom")
fmt.Print(bf.String()) // hello tom
// render template without layout
r.Partial(bf, "home", "tom")
bf.Reset()
// render with default layout
r.Render(bf, "home", "tom")
bf.Reset()
// render with custom layout
r.Render(bf, "home", "tom", "site/layout")
bf.Reset()
// load named string template
r.LoadString("my-page", "welcome {{.}}")
// now, you can use "my-page" as an template name
r.Partial(bf, "my-page", "tom") // welcome tom
bf.Reset()
// more ways for load templates
r.LoadByGlob("some/path/*", "some/path")
r.LoadFiles("path/file1.tpl", "path/file2.tpl")
}more API please GoDoc
Layout Example
basic layout structure:
{{ include "part0" }}{{ yield }}{{ include "part1" }}
current template will render at
{{ yield }}
example files:
templates/
|_ layouts/
| |_ default.tpl
| |_ header.tpl
| |_ footer.tpl
|_ home.tpl
|_ about.tpl
- layout:
templates/layouts/default.tpl
<html>
<head>
<title>layout example</title>
</head>
<body>
<!-- include "layouts/header.tpl" -->
{{ include "header" }}
<!-- Render the current template here -->
{{ yield }}
<!-- include "layouts/footer.tpl" -->
{{ include "footer" }}
</body>
</html>templates/layouts/header.tpl
<header>
<h2>page header</h2>
</header>templates/layouts/footer.tpl
<footer>
<h2>page footer</h2>
</footer>templates/home.tpl
<h1>Hello, {{ .Name | upper }}</h1>
<h2>At template {{ current }}</h2>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit.</p>Usage
v := view.NewInitialized(func(r *view.Renderer) {
// setting default layout
r.Layout = "layouts/default" // equals to "layouts/default.tpl"
// templates dir. will auto load on init.
r.ViewsDir = "templates"
})
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
v.Render(w, "home", view.M{"Name": "tom"})
})
log.Println("Listening port: 9100")
http.ListenAndServe(":9100", nil)Available Options
// Debug setting
Debug bool
// Layout template name
Layout string
// Delims define for template
Delims TplDelims
// ViewsDir the default views directory
ViewsDir string
// ExtNames allowed template extensions. eg {"tpl", "html"}
ExtNames []string
// FuncMap func map for template
FuncMap template.FuncMap
// DisableLayout disable layout. default is False
DisableLayout bool
// AutoSearchFile auto search template file, when not found on compiled templates. default is False
AutoSearchFile boolApply options
- method 1
r := NewRenderer()
r.Layout = "layouts/default"
// ... ...
r.MustInitialize()- method 2
r := NewRenderer(func (r *Renderer) {
r.Layout = "layouts/default"
// ... ...
})
r.MustInitialize()- method 3
r := NewInitialized(func (r *Renderer) {
r.Layout = "layouts/default"
// ... ...
})Reference
License
MIT