jet

package module
v2.1.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 20, 2024 License: MIT Imports: 12 Imported by: 5

README


id: jet title: Jet

Release Discord Test Security Linter

Jet is a template engine create by cloudykit, to see the original syntax documentation please click here

Basic Example

./views/index.jet

{{include "partials/header"}}

<h1>{{ Title }}</h1>

{{include "partials/footer"}}

./views/partials/header.jet

<h2>Header</h2>

./views/partials/footer.jet

<h2>Footer</h2>

./views/layouts/main.jet

<!DOCTYPE html>
<html>

<head>
  <title>Title</title>
</head>

<body>
  {{ embed() }}
</body>

</html>
package main

import (
	"log"
	
	"github.com/gofiber/fiber/v2"
	"github.com/gofiber/template/jet/v2"
)

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

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

	// 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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Engine

type Engine struct {
	core.Engine
	// templates
	Templates *jet.Set
}

Engine struct

func New

func New(directory, extension string) *Engine

New returns a Jet render engine for Fiber

func NewFileSystem

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

NewFileSystem returns a Jet 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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL