templatex

The missing function for parsing nested templates in Go, like you know it from Laravel, Django, etc.

Use the whole feature set of Go's templating library
No new syntax or keywords. Just Go's templating functions in the right order
No dependencies, just Go's standard library
Super easy to use

Your template structure can now look like this and parsing will be done for you:

templates/
  layout.html

  includes/
    header.html
    footer.html

  dashboard/
    includes/
      widgets.html
    view.html
    edit.html

  profile/
    view.html
    edit.html

    payments/
      methods.html
      add.html

Installation

go get -u github.com/philippta/templatex

Usage

templatex is very easy to use as it only has one type and three methods. The most basic way to use it is with default options. This will parse the templates/ dire

t := templatex.New()

t.ParseDir("templates/")

t.ExecuteTemplate(w, "profile/view", userdata)

The parser also has options to use different names for the includes directory and layout files. Additional template functions can also be supplied:

t := &templatex.Template{
    Layout:     "layout.html",
    IncludeDir: "includes",
    FuncMap: template.FuncMap{
        "uppercase": strings.ToUpper,
    },
}

Parsing order

Based on the example from above:

templates/
  layout.html

  includes/
    header.html
    footer.html

  dashboard/
    includes/
      widgets.html
    view.html
    edit.html

  profile/
    view.html
    edit.html

    payments/
      methods.html
      add.html

templatex will parse the templates in the following order:

dashboard/view:
  templates/includes/header.html
  templates/includes/footer.html
  templates/dashboard/includes/widgets.html
  templates/layout.html
  templates/dashboard/view.html

dashboard/edit:
  templates/includes/header.html
  templates/includes/footer.html
  templates/dashboard/includes/widgets.html
  templates/layout.html
  templates/dashboard/edit.html

profile/view:
  templates/includes/header.html
  templates/includes/footer.html
  templates/layout.html
  templates/profile/view.html

profile/edit:
  templates/includes/header.html
  templates/includes/footer.html
  templates/layout.html
  templates/profile/edit.html

profile/payments/methods:
  templates/includes/header.html
  templates/includes/footer.html
  templates/layout.html
  templates/profile/payments/methods.html

profile/payments/add:
  templates/includes/header.html
  templates/includes/footer.html
  templates/layout.html
  templates/profile/payments/add.html

Defining nested templates

Defining nested templates in Go is relatively simple. There are just three instructions you should keep in mind:

block for creating an new block
define for filling a block
template for rendering a partial/include template

Step 1: Creating a block

Creating a block is the essential part for nested templates, as these parts can be later filled by a child template. It is created by the block command.

<!-- layout.html -->
<body>
    <h1>
        {{block "title" .}}Default Title{{end}}
    </h1>

    {{block "content" .}}
        <p>
            This renders, when the block has not been filled.
            Otherwise this message is discarded.
            Good for default content.
        </p>
    {{end}}
</body>

Step 2: Filling a block

Filling a block which was created in a parent template is done with the define command. So basically, we redefine the contents of a block.

<!-- profile/view.html -->
{{define "title"}}
    You're on profile/view
{{end}}

{{define "content"}}
    <p>
        This will render inside the "content" block.
        There is no need to place any html outside of this block
    </p>
{{end}}

Step 3: Using partial/include templates

Creating an include template is similar to step 2. Here we're not redefining a existing block. We rather define a new block which is not rendered immediately.

<!-- includes/footer.html -->
{{define "footer"}}
    &copy; Company 2020. All rights reserved
{{end}}

Then render it like this with the template command:

<!-- layout.html again -->
...
{{template "footer" .}} <!-- notice: no {{end}} here -->
</body>

philippta / templatex

templatex

Installation

Usage

Parsing order

Defining nested templates

Step 1: Creating a block

Step 2: Filling a block

Step 3: Using partial/include templates

Example

License

Enjoy :-)

About

Languages