slim

README

---

id: slim title: Slim

Slim is a template engine created by mattn, to see the original syntax documentation please click here

Basic Example

./views/index.slim

== render("partials/header.slim")

h1 = Title

== render("partials/footer.slim")

./views/partials/header.slim

h2 = Header

./views/partials/footer.slim

h2 = Footer

./views/layouts/main.slim

doctype html
html
  head
    title Main
    include ../partials/meta.slim
  body
    | {{embed}}

package main

import (
	"log"

	"github.com/gofiber/fiber/v2"
	"github.com/gofiber/template/slim/v2"

	// "net/http" // embedded system
)

func main() {
	// Create a new engine
	engine := slim.New("./views", ".slim")

	// Or from an embedded system
	// See github.com/gofiber/embed for examples
	// engine := slim.NewFileSystem(http.Dir("./views", ".slim"))

	// 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"))
}

Documentation

Index

• type Engine
  • func New(directory, extension string) *Engine
  • func NewFileSystem(fs http.FileSystem, extension string) *Engine
  • func (e *Engine) Load() error
  • func (e *Engine) Render(out io.Writer, name string, binding interface{}, layout ...string) error

Types

type Engine

type Engine struct {
	core.Engine
	// templates
	Templates map[string]*slim.Template
}

Engine struct

func New

func New(directory, extension string) *Engine

New returns a Slim render engine for Fiber

func NewFileSystem

func NewFileSystem(fs http.FileSystem, extension string) *Engine

NewFileSystem returns a Slim render engine for Fiber with file system

func (*Engine) Load

func (e *Engine) Load() error

Load parses the templates to the engine.

func (*Engine) Render

func (e *Engine) Render(out io.Writer, name string, binding interface{}, layout ...string) error

Render will render the template by name