autoescape

Source: lib/tags/autoescape.js

Control auto-escaping of variable output from within your templates.

Parameters

Examples

// myvar = '<foo>';
{% autoescape true %}{{ myvar }}{% endautoescape %}
// => <foo>
{% autoescape false %}{{ myvar }}{% endautoescape %}
// => <foo>

block

Source: lib/tags/block.js

Defines a block in a template that can be overridden by a template extending this one and/or will override the current template's parent template block of the same name.

See Template Inheritance for more information.

Parameters

Examples

{% block body %}...{% endblock %}

else

Source: lib/tags/else.js

Used within an {% if %} tag, the code block following this tag up until {% endif %} will be rendered if the if statement returns false.

Examples

{% if false %}
  statement1
{% else %}
  statement2
{% endif %}
// => statement2

elif

Source: lib/tags/elseif.js

Like {% else %}, except this tag can take more conditional statements.

Parameters

Examples

{% if false %}
  Tacos
{% elseif true %}
  Burritos
{% else %}
  Churros
{% endif %}
// => Burritos

extends

Source: lib/tags/extends.js

Makes the current template extend a parent template. This tag must be the first item in your template.

See Template Inheritance for more information.

Parameters

Examples

{% extends "./layout.html" %}

filter

Source: lib/tags/filter.js

Apply a filter to an entire block of template.

Parameters

Examples

{% filter uppercase %}oh hi, {{ name }}{% endfilter %}
// => OH HI, PAUL

{% filter replace(".", "!", "g") %}Hi. My name is Paul.{% endfilter %}
// => Hi! My name is Paul!

for

Source: lib/tags/for.js

Loop over objects and arrays.

Parameters

Returns

loop.index: The current iteration of the loop (1-indexed)

loop.index0: The current iteration of the loop (0-indexed)

loop.revindex: The number of iterations from the end of the loop (1-indexed)

loop.revindex0: The number of iterations from the end of the loop (0-indexed)

loop.key: If the iterator is an object, this will be the key of the current item, otherwise it will be the same as the loop.index.

loop.first: True if the current object is the first in the object or array.

loop.last: True if the current object is the last in the object or array.

Examples

// obj = { one: 'hi', two: 'bye' };
{% for x in obj %}
  {% if loop.first %}<ul>{% endif %}
  <li>{{ loop.index }} - {{ loop.key }}: {{ x }}</li>
  {% if loop.last %}</ul>{% endif %}
{% endfor %}
// => <ul>
//    <li>1 - one: hi</li>
//    <li>2 - two: bye</li>
//    </ul>

// arr = [1, 2, 3]
// Reverse the array, shortcut the key/index to `key`
{% for key, val in arr|reverse %}
{{ key }} -- {{ val }}
{% endfor %}
// => 0 -- 3
//    1 -- 2
//    2 -- 1

if

Source: lib/tags/if.js

Used to create conditional statements in templates. Accepts most JavaScript valid comparisons.

Can be used in conjunction with {% elseif ... %} and {% else %} tags.

Parameters

Examples

{% if x %}{% endif %}
{% if !x %}{% endif %}
{% if not x %}{% endif %}

{% if x and y %}{% endif %}
{% if x && y %}{% endif %}
{% if x or y %}{% endif %}
{% if x || y %}{% endif %}
{% if x || (y && z) %}{% endif %}

{% if x [operator] y %}
  Operators: ==, !=, <, <=, >, >=, ===, !==
{% endif %}

{% if x == 'five' %}
  The operands can be also be string or number literals
{% endif %}

{% if x|lower === 'tacos' %}
  You can use filters on any operand in the statement.
{% endif %}

{% if x in y %}
  If x is a value that is present in y, this will return true.
{% endif %}

import

Source: lib/tags/import.js

Allows you to import macros from another file directly into your current context.

The import tag is specifically designed for importing macros into your template with a specific context scope. This is very useful for keeping your macros from overriding template context that is being injected by your server-side page generation.

Parameters

Examples

{% import './formmacros.html' as form %}
{{ form.input("text", "name") }}
// => <input type="text" name="name">

{% import "../shared/tags.html" as tags %}
{{ tags.stylesheet('global') }}
// => <link rel="stylesheet" href="/global.css">

include

Source: lib/tags/include.js

Includes a template partial in place. The template is rendered within the current locals variable context.

Parameters

Examples

// food = 'burritos';
// drink = 'lemonade';
{% include "./partial.html" %}
// => I like burritos and lemonade.

// my_obj = { food: 'tacos', drink: 'horchata' };
{% include "./partial.html" with my_obj only %}
// => I like tacos and horchata.

{% include "/this/file/does/not/exist" ignore missing %}
// => (Nothing! empty string)

macro

Source: lib/tags/macro.js

Create custom, reusable snippets within your templates.

Can be imported from one template to another using the {% import ... %} tag.

Parameters

Examples

{% macro input(type, name, id, label, value, error) %}
  <label for="{{ name }}">{{ label }}</label>
  <input type="{{ type }}" name="{{ name }}" id="{{ id }}" value="{{ value }}"{% if error %} class="error"{% endif %}>
{% endmacro %}

{{ input("text", "fname", "fname", "First Name", fname.value, fname.errors) }}
// => <label for="fname">First Name</label>
//    <input type="text" name="fname" id="fname" value="">

parent

Source: lib/tags/parent.js

Inject the content from the parent template's block of the same name into the current block.

See Template Inheritance for more information.

Examples

{% extends "./foo.html" %}
{% block content %}
  My content.
  {% parent %}
{% endblock %}

raw

Source: lib/tags/raw.js

Forces the content to not be auto-escaped. All swig instructions will be ignored and the content will be rendered exactly as it was given.

Examples

// foobar = '<p>'
{% raw %}{{ foobar }}{% endraw %}
// => {{ foobar }}

set

Source: lib/tags/set.js

Set a variable for re-use in the current context. This will over-write any value already set to the context for the given varname.

Parameters

Examples

{% set foo = "anything!" %}
{{ foo }}
// => anything!

// index = 2;
{% set bar = 1 %}
{% set bar += index|default(3) %}
// => 3

// foods = {};
// food = 'chili';
{% set foods[food] = "con queso" %}
{{ foods.chili }}
// => con queso

// foods = { chili: 'chili con queso' }
{% set foods.chili = "guatamalan insanity pepper" %}
{{ foods.chili }}
// => guatamalan insanity pepper

spaceless

Source: lib/tags/spaceless.js

Attempts to remove whitespace between HTML tags. Use at your own risk.

Examples

{% spaceless %}
  {% for num in foo %}
  <li>{{ loop.index }}</li>
  {% endfor %}
{% endspaceless %}
// => <li>1</li><li>2</li><li>3</li>