README
¶
Grender 
Deprecation notice
This package could be more focused, so it was split up into two improved packages:
- dannyvankooten/respond for responding to HTTP requests.
- dannyvankooten/extemplate for file-based template inheritance using html/template.
Grender is a package that provides functionality for easily rendering HTML templates and JSON or XML data to a HTTP response. It is based on github.com/unrolled/render with some subtle modifications when it comes to rendering HTML templates.
- Templates inheritance:
{{/* extends "master.tmpl" */}} - Glob configuration:
templates/*.tmpl - Normal templates as partials:
{{ template "footer" .}}
Usage
Grender can be used with pretty much any web framework providing you can access the http.ResponseWriter from your handler. The rendering functions simply wraps Go's existing functionality for marshaling and rendering data.
- HTML: Uses the html/template package to render HTML templates.
- JSON: Uses the encoding/json package to marshal data into a JSON-encoded response.
- XML: Uses the encoding/xml package to marshal data into an XML-encoded response.
- Text: Passes the incoming string straight through to the
http.ResponseWriter.
// main.go
package main
import (
"net/http"
"github.com/dannyvankooten/grender"
)
func main() {
r := grender.New(grender.Options{
Charset: "ISO-8859-1",
TemplatesGlob: "examples/*.tmpl",
})
mux := http.NewServeMux()
// This will set the Content-Type header to "application/json; charset=ISO-8859-1".
mux.HandleFunc("/json", func(w http.ResponseWriter, req *http.Request) {
r.JSON(w, http.StatusOK, map[string]string{"hello": "world"})
})
// This will set the Content-Type header to "text/html; charset=ISO-8859-1".
mux.HandleFunc("/html", func(w http.ResponseWriter, req *http.Request) {
r.HTML(w, http.StatusOK, "hello.tmpl", "world")
})
http.ListenAndServe("127.0.0.1:3000", mux)
}
Options
Grender comes with a variety of configuration options. The defaults are listed below.
r := grender.New(grender.Options{
Debug: false, // If true, templates will be recompiled before each render call
TemplatesGlob: "", // Glob to your template files
PartialsGlob: "", // Glob to your patials or global templates
Funcs: nil, // Your template FuncMap
Charset: "UTF-8", // Charset to use for Content-Type header values
})
Extending another template
First, define your parent template like this.
file: master.tmpl
<html>
{{template "content" .}}
</html>
Then, in a separate template file use a template comment on the first line to indicate that you want to extend the other template file.
file: child.tmpl
{{/* extends "master.tmpl" */}}
{{define "content"}}Hello world!{{end}}
More examples
The grender_test.go file contains additional usage examples.
License
See LICENSE file.
Documentation
¶
Index ¶
- Constants
- type BufferPool
- type Grender
- func (r *Grender) HTML(w http.ResponseWriter, statusCode int, templateName string, data interface{}) error
- func (r *Grender) JSON(w http.ResponseWriter, statusCode int, data interface{}) error
- func (r *Grender) Text(w http.ResponseWriter, statusCode int, data string) error
- func (r *Grender) XML(w http.ResponseWriter, statusCode int, data interface{}) error
- type Options
Constants ¶
const ( // ContentHTML HTTP header value for HTML data ContentHTML = "text/html" // ContentJSON HTTP header value for JSON data ContentJSON = "application/json" // ContentType HTTP header name for defining the content type ContentType = "Content-Type" // ContentText header value for Text data. ContentText = "text/plain" // ContentXML header value for XML data. ContentXML = "text/xml" // DefaultCharset for when no specific Charset Options was given DefaultCharset = "UTF-8" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BufferPool ¶
type BufferPool struct {
// contains filtered or unexported fields
}
BufferPool implements a pool of bytes.Buffers in the form of a bounded channel. Pulled from the github.com/oxtoacart/bpool package (Apache licensed).
func NewBufferPool ¶
func NewBufferPool(size int) (bp *BufferPool)
NewBufferPool creates a new BufferPool bounded to the given size.
func (*BufferPool) Get ¶
func (bp *BufferPool) Get() (b *bytes.Buffer)
Get gets a Buffer from the BufferPool, or creates a new one if none are available in the pool.
func (*BufferPool) Put ¶
func (bp *BufferPool) Put(b *bytes.Buffer)
Put returns the given Buffer to the BufferPool.
type Grender ¶
type Grender struct {
Options Options
Templates templates
}
Grender provides functions for easily writing HTML templates & JSON out to a HTTP Response.
func (*Grender) HTML ¶
func (r *Grender) HTML(w http.ResponseWriter, statusCode int, templateName string, data interface{}) error
HTML executes the template and writes to the responsewriter
func (*Grender) JSON ¶
func (r *Grender) JSON(w http.ResponseWriter, statusCode int, data interface{}) error
JSON renders the data as a JSON HTTP response to the ResponseWriter
type Options ¶
type Options struct {
// With Debug set to true, templates will be recompiled before every render call.
Debug bool
// The glob string to your templates
TemplatesGlob string
// The Glob string for additional templates
PartialsGlob string
// The function map to pass to each HTML template
Funcs template.FuncMap
// Charset for responses
Charset string
}
Options holds the configuration Options for a Renderer
Source Files