README
¶
renders
New template render of macaron framework
Macaron middleware/handler for rendering serialized JSON, XML, and HTML template responses.
Installation
go get github.com/go-macaron/renders
Examples
Check out the examples folder for some examples
Usage
render uses Go's html/template package to render html templates.
// main.go
package main
import (
"gopkg.in/macaron.v1"
"github.com/go-macaron/renders"
)
func main() {
m := macaron.Classic()
m.Use(renders.Renderer(
renders.Options{
Directory: "templates", // Specify what path to load the templates from.
Extensions: []string{".tmpl", ".html"}, // Specify extensions to load for templates.
//Funcs: FuncMap, // Specify helper function maps for templates to access.
Charset: "UTF-8", // Sets encoding for json and html content-types. Default is "UTF-8".
IndentJSON: true, // Output human readable JSON
IndentXML: true, // Output human readable XML
HTMLContentType: "text/html", // Output XHTML content type instead of default "text/html"
}))
m.Get("/", func(r renders.Render) {
r.HTML(200, "pages/index.html", map[string]interface{}{"Title": "Home"})
})
m.Get("/profile", func(r renders.Render) {
r.HTML(200, "pages/profile.tmpl", map[string]interface{}{"Title": "Profile"})
})
m.Get("/map", func(r renders.Render) {
r.HTML(200, "pages/map.html", map[string]interface{}{"Title": "Map"})
})
m.Run()
}
Options
renders.Renderer comes with a variety of configuration options:
// ...
m.Use(renders.Renderer(renders.Options{
Directory: "templates", // Specify what path to load the templates from.
Extensions: []string{".tmpl", ".html"}, // Specify extensions to load for templates.
//Funcs: template.FuncMap{AppHelpers}, // Specify helper function maps for templates to access.
Charset: "UTF-8", // Sets encoding for json and html content-types. Default is "UTF-8".
IndentJSON: true, // Output human readable JSON
IndentXML: true, // Output human readable XML
HTMLContentType: "text/html", // Output XHTML content type instead of default "text/html"
}))
// ...
Extends
Just use the standard template keyword with a *.html file path. REMEMBER to pass the context to the parent template with the trailing dot (. }}).
index.html
{{ template "templates/layouts/fullwidth.html" . }}
{{ define "content" }}
content of index to be inserted into the fullwidth template
{{ end }}
This will also work with multi-level support, e.g.
index.html ---extends---> layouts/fullwidth.html ---extends---> base.html
Include
Automatically parse the right file just by writing the path to it
{{ define "content" }}
content of the fullwidth template
{{ template "includes/widgets/signup.html" . }}
{{ end }}
Overwriting define / default value
Any "define" of the same "template" down the extend chain will overwrite the former content This can be used to define default values for a {{ template }} like so
base.html
<!DOCTYPE html>
<html>
<head>
<title>{{ template "title" }}</title>
</head>
</html>
{{ define "title" }}Default Title{{ end }}
profile.html
{{ template "templates/base.html" . }}
{{ define "title" }}Hello World{{ end }}
This would produce panic in std lib parsing but now it works by simply renaming the define's further down the chain not to interrupt the most specific one.
Authors
Documentation
¶
Index ¶
Constants ¶
const ( ContentType = "Content-Type" ContentLength = "Content-Length" ContentBinary = "application/octet-stream" ContentJSON = "application/json" ContentHTML = "text/html" ContentXHTML = "application/xhtml+xml" ContentXML = "text/xml" )
Variables ¶
This section is empty.
Functions ¶
func LoadWithFuncMap ¶
LoadWithFuncMap prepares and parses all templates from the passed basePath and injects a custom template.FuncMap into each template
Types ¶
type Options ¶
type Options struct {
// Directory to load templates. Default is "templates"
Directory string
// Extensions to parse template files from. Defaults to [".tmpl"]
Extensions []string
// Funcs is a slice of FuncMaps to apply to the template upon compilation. This is useful for helper functions. Defaults to [].
Funcs template.FuncMap
// Appends the given charset to the Content-Type header. Default is "UTF-8".
Charset string
// Outputs human readable JSON
IndentJSON bool
// Outputs human readable XML
IndentXML bool
// Prefixes the JSON output with the given bytes.
PrefixJSON []byte
// Prefixes the XML output with the given bytes.
PrefixXML []byte
// Allows changing of output to XHTML instead of HTML. Default is "text/html"
HTMLContentType string
}
Options is a struct for specifying configuration options for the render.Renderer middleware
type Render ¶
type Render interface {
// JSON writes the given status and JSON serialized version of the given value to the http.ResponseWriter.
JSON(status int, v interface{})
// HTML renders a html template specified by the name and writes the result and given status to the http.ResponseWriter.
HTML(status int, name string, v interface{})
// XML writes the given status and XML serialized version of the given value to the http.ResponseWriter.
XML(status int, v interface{})
// Data writes the raw byte array to the http.ResponseWriter.
Data(status int, v []byte)
// Error is a convenience function that writes an http status to the http.ResponseWriter.
Error(status int)
// Status is an alias for Error (writes an http status to the http.ResponseWriter)
Status(status int)
// Redirect is a convienience function that sends an HTTP redirect. If status is omitted, uses 302 (Found)
Redirect(location string, status ...int)
// Template returns the internal *template.Template used to render the HTML
Template(name string) *template.Template
// Header exposes the header struct from http.ResponseWriter.
Header() http.Header
}
Source Files
Directories