Skip to content

nicolasparada/go-tmpl-renderer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go Reference

Golang Template Renderer

An opinionated HTML template renderer for Golang.

Install

go get github.com/nicolasparada/go-tmpl-renderer

Usage

templates/includes/layout.tmpl

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Golang Template Renderer Demo</title>
</head>
<body>
    {{template "header.tmpl" .}}
    {{block "content" .}}{{end}}
</body>
</html>

templates/includes/header.tmpl

<header>
  <a href="/"><h1>Home</h1></a>
</header>

templates/welcome.tmpl

{{template "layout.tmpl" .}}

{{define "content"}}
  <main>
    <h1>Welcome</h1>
  </main>
{{end}}

main.go

package main

import (
    // other imports
    tmplrenderer "github.com/nicolasparada/go-tmpl-renderer"
)

//go:embed templates/includes/*.tmpl templates/*.tmpl
var templatesFS embed.FS

func main() {
    renderer := &tmplrenderer.Renderer{
        FS:             templatesFS,
        BaseDir:        "templates",
        IncludePatters: []string{"includes/*.tmpl"},
    }

    http.HandleFunc("/welcome", func(w http.ResponseWriter, r *http.Request) {
        renderer.Render(w, "welcome.tmpl", nil)
    })
    http.ListenAndServe(":4000")
}

Included Functions

HTML templates will include two functions from the start: dict and list.

  • dict given a list of key-value pairs, it will construct a map map[string]any out of it.
    Example:
{{$_ := dict "foo" "bar"}} => map[string]any{"foo": "bar"}

It's very usefull for passing named parameters to other templates, for example:

{{define "greet"}}
    Hello, {{.Name}}!
{{end}}

{{template "greet" dict
  "Name" "john"
}}
  • list: given a list of items, it will construct an slice []any out of it.
    Example:
{{$_ := list "foo" "bar"}} => []any{"foo", "bar"}

About

An opinionated HTML template renderer for Golang

Topics

Resources

License

Stars

Watchers

Forks

Languages