README
¶
HTML
HTML is the official Go template engine html/template, to see the original syntax documentation please click here
Basic Example
./views/index.html
{{template "partials/header" .}}
<h1>{{.Title}}</h1>
{{template "partials/footer" .}}
./views/partials/header.html
<h2>Header</h2>
./views/partials/footer.html
<h2>Footer</h2>
./views/layouts/main.html
<!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/html"
)
func main() {
// Create a new engine
engine := html.New("./views", ".html")
// Or from an embedded system
// See github.com/gofiber/embed for examples
// engine := html.NewFileSystem(http.Dir("./views", ".html"))
// 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"))
}
Example with embed.FS
package main
import (
"log"
"net/http"
"embed"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/template/html"
)
//go:embed views/*
var viewsfs embed.FS
func main() {
engine := html.NewFileSystem(http.FS(viewsfs), ".html")
// Pass the engine to the Views
app := fiber.New(fiber.Config{
Views: engine,
})
app.Get("/", func(c *fiber.Ctx) error {
// Render index - start with views directory
return c.Render("views/index", fiber.Map{
"Title": "Hello, World!",
})
})
log.Fatal(app.Listen(":3000"))
}
and change the starting point to the views directory
./views/index.html
{{template "views/partials/header" .}}
<h1>{{.Title}}</h1>
{{template "views/partials/footer" .}}
Example with innerHTML
package main
import (
"embed"
"html/template"
"log"
"net/http"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/template/html"
)
//go:embed views/*
var viewsfs embed.FS
func main() {
engine := html.NewFileSystem(http.FS(viewsfs), ".html")
engine.AddFunc(
// add unescape function
"unescape", func(s string) template.HTML {
return template.HTML(s)
},
)
// 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("views/index", fiber.Map{
"Title": "Hello, <b>World</b>!",
})
})
log.Fatal(app.Listen(":3000"))
}
and change the starting point to the views directory
./views/index.html
<p>{{ unescape .Title}}</p>
html output
<p>Hello, <b>World</b>!</p>
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 *template.Template
// contains filtered or unexported fields
}
Engine struct
func NewFileSystem ¶ added in v1.5.0
func NewFileSystem(fs http.FileSystem, extension string) *Engine
NewFileSystem ...
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