Module Templates

Configuration

Values for variables have to be provided in the file placed at the top level of the module:

modules
└──my-custom-module
    ├── template-values.json
    ├── private
    │   └── graphql
    │       ├── get_customizations.graphql
    │       └── get_pages.graphql
    └── public
        └── views
            └── pages
                └── dashboard.liquid

Adding templates to module code

Templates work in deploy mode (with the command) and sync mode (with the command). When the file is present, the finds it and applies its values to the templates. It then sends the output to the server with the resulting file filled in based on the templates.

In both deploy and sync modes, adding templates to module code works similarly. If you have sync mode running and you change the file, then change one of the files using the template, they get processed, and the latest version gets uploaded.

Markup

Everything between and is interpreted as a key to be found in the template configuration file. There is no logic supported; the only available filter is , which unescapes the value provided by the user (by default, they are all escaped).

Example

If you have a page with this code:

---
slug: <%= &slug =%>
layout: modules/contact_form/main
---

<h1><%= title =%></h1>

And a top-level  with:

{
  "slug": "contact_form",
  "title": "Contact Page title"
}

During deploy or sync, it will get filled in and sent to the server as follows:

---
slug: contact_form
layout: modules/contact_form/main
---

<h1>Contact Page title</h1>

Related Topic

Configuring a Module Template