up, next

Template inheritance

Templates may contain inheritable sections. Those sections start with a dollar instead of a pound. For example, let's consider the following template:

layout.mustache:

<html>
<head>
    <title>{{$ page_title }}Default title{{/ page_title }}</title>
</head>
<body>
    <h1>{{$ page_title }}Default title{{/ page_title }}</h1>
    {{$ page_content }}
        Default content
    {{/ page_content }}
</body>
</html>

You can inherit from it from another template, and override its sections:

article.mustache:

{{< layout }}

    {{$ page_title }}{{ article.title }}{{/ page_title }}
    
    {{$ page_content }}
        {{# article }}
            {{ body }}
            by {{ author }}
        {{/ article }}
    {{/ page_content }}
    
{{/ layout }}

When you render article.mustache, you get a full HTML page.

The loading of inherited template follow the same rules as the partial loading tag {{> partial }}. Check the Partial Guide for more information.

Compatibility with other Mustache implementations

The Mustache specification does not have the concept of template inheritance.

Our support for this feature was inspired by hogan.js and spullara/mustache.java.

GRMustache passes all template inheritance tests from hogan.js & mustache.java, without exact white-space conformance: GRMustache doesn't honor line suppression, indentation and other white-space niceties.

The reciprocal is not sure: hogan.js & mustache.java may, or not, pass all template inheritance tests (1, 2) of GRMustache.

As a consequence, if your goal is to design templates that are compatible with other Mustache implementations, use template inheritance with great care.

up, next

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!