README
¶
Django
Django is a template engine create by flosch, to see the original syntax documentation please click here
Basic Example
./views/index.django
{% include "partials/header.django" %}
<h1>{{ Title }}</h1>
{% include "partials/footer.django" %}
./views/partials/header.django
<h2>Header</h2>
./views/partials/footer.django
<h2>Footer</h2>
./views/layouts/main.django
<!DOCTYPE html>
<html>
<head>
<title>Main</title>
</head>
<body>
{{embed}}
</body>
</html>
package main
import (
"log"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/template/django"
)
func main() {
// Create a new engine
engine := django.New("./views", ".django")
// Or from an embedded system
// See github.com/gofiber/embed for examples
// engine := html.NewFileSystem(http.Dir("./views", ".django"))
// Pass the engine to the Views
app := fiber.New(fiber.Config{
Views: engine,
})
app.Get("/", func(c *fiber.Ctx) error {
// Render index
return c.Render("index", fiber.Map{
"Title": "Hello, World!",
})
})
app.Get("/layout", func(c *fiber.Ctx) error {
// Render index within layouts/main
return c.Render("index", fiber.Map{
"Title": "Hello, World!",
}, "layouts/main")
})
log.Fatal(app.Listen(":3000"))
}
Using embedded file system (1.16+ only)
When using the // go:embed directive, resolution of inherited templates using django's {% extend '' %} keyword fails when instantiating the template engine with django.NewFileSystem(). In that case, use the django.NewPathForwardingFileSystem() function to instantiate the template engine.
This function provides the proper configuration for resolving inherited templates.
Assume you have the following files:
then
package main
import (
"log"
"embed"
"net/http"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/template/django"
)
//go:embed views
var viewsAsssets embed.FS
func main() {
// Create a new engine
engine := NewPathForwardingFileSystem(http.FS(viewsAsssets), "/views", ".django")
// Pass the engine to the Views
app := fiber.New(fiber.Config{
Views: engine,
})
app.Get("/", func(c *fiber.Ctx) error {
// Render descendant
return c.Render("descendant", fiber.Map{
"greeting": "World",
})
})
log.Fatal(app.Listen(":3000"))
}
Register and use custom functions
// My custom function
func Nl2brHtml(value interface{}) string {
if str, ok := value.(string); ok {
return strings.Replace(str, "\n", "<br />", -1)
}
return ""
}
// Create a new engine
engine := django.New("./views", ".django")
// register functions
engine.AddFunc("nl2br", Nl2brHtml)
// Pass the engine to the Views
app := fiber.New(fiber.Config{Views: engine})
in the handler
c.Render("index", fiber.Map{
"Fiber": "Hello, World!\n\nGreetings from Fiber Team",
})
./views/index.django
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"></head>
<body>
{{ nl2br(Fiber) }}
</body>
</html>
Output:
<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"></head>
<body>
Hello, World!<br /><br />Greetings from Fiber Team
</body>
</html>
Documentation
¶
Index ¶
- type Engine
- func (e *Engine) AddFunc(name string, fn interface{}) *Engine
- func (e *Engine) Debug(enabled bool) *Engine
- func (e *Engine) Delims(left, right string) *Engine
- func (e *Engine) Layout(key string) *Engine
- func (e *Engine) Load() error
- func (e *Engine) Parse() error
- func (e *Engine) Reload(enabled bool) *Engine
- func (e *Engine) Render(out io.Writer, template string, binding interface{}, layout ...string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Engine ¶
type Engine struct {
// templates
Templates map[string]*pongo2.Template
// contains filtered or unexported fields
}
Engine struct
func NewFileSystem ¶ added in v1.5.0
func NewFileSystem(fs http.FileSystem, extension string) *Engine
func NewPathForwardingFileSystem ¶ added in v1.7.0
func NewPathForwardingFileSystem(fs http.FileSystem, directory string, extension string) *Engine
NewPathForwardingFileSystem Passes "directory" to the template engine where alternative functions don't.
This fixes errors during resolution of templates when "{% extends 'parent.html' %}" is used.
func (*Engine) AddFunc ¶ added in v1.4.0
AddFunc adds the function to the template's function map. It is legal to overwrite elements of the default actions
func (*Engine) Debug ¶ added in v1.4.0
Debug will print the parsed templates when Load is triggered.
func (*Engine) Delims ¶ added in v1.4.0
Delims sets the action delimiters to the specified strings, to be used in templates. An empty delimiter stands for the corresponding default: {{ or }}.
func (*Engine) Layout ¶ added in v1.4.0
Layout defines the variable name that will incapsulate the template
Source Files
Directories