kemko/liquid
1
0
Fork 0
mirror of https://github.com/kemko/liquid.git synced 2026-01-06 10:15:40 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add new Template page for comment, raw, liquid, echo, render, include

Browse Source
This commit is contained in:
EricFromCanada
2021-02-22 18:00:22 -05:00
parent d8f5d65e32
commit 77c2dfa989
4 changed files with 173 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
_basics/introduction.md
View File

@@ -46,6 +46,7 @@ Tags can be categorized into various types:
- [Control flow]({{ "/tags/control-flow/" | prepend: site.baseurl }})
- [Iteration]({{ "/tags/iteration/" | prepend: site.baseurl }})
- [Template]({{ "/tags/template/" | prepend: site.baseurl }})
- [Variable assignment]({{ "/tags/variable/" | prepend: site.baseurl }})
You can read more about each type of tag in their respective sections.

20
_tags/comment.md
View File

@@ -1,20 +0,0 @@
---
title: Comment
description: An overview of comment tags in the Liquid template language.
---
Allows you to leave un-rendered code inside a Liquid template. Any text within the opening and closing `comment` blocks will not be printed, and any Liquid code within will not be executed.
<p class="code-label">Input</p>
```liquid
{% raw %}
Anything you put between {% comment %} and {% endcomment %} tags
is turned into a comment.
{% endraw %}
```
<p class="code-label">Output</p>
```liquid
Anything you put between {% comment %} and {% endcomment %} tags
is turned into a comment.
```

20
_tags/raw.md
View File

@@ -1,20 +0,0 @@
---
title: Raw
description: An overview of raw tags in the Liquid template language.
---
Temporarily disables tag processing. This is useful for generating certain content that uses conflicting syntax, such as [Mustache](https://mustache.github.io/) or [Handlebars](https://handlebarsjs.com/).
<p class="code-label">Input</p>
```liquid
{{ "%7B%25+raw+%25%7D" | url_decode }}{% raw %}
In Handlebars, {{ this }} will be HTML-escaped, but {{{ that }}} will not.
{% endraw %}{{ "%7B%25+endraw+%25%7D" | url_decode }}
```
<p class="code-label">Output</p>
```text
{% raw %}
In Handlebars, {{ this }} will be HTML-escaped, but {{{ that }}} will not.
{% endraw %}
```

172
_tags/template.md Normal file
View File

@@ -0,0 +1,172 @@
---
title: Template
description: An overview of template tags in the Liquid template language.
redirect_from:
- /tags/comment/
- /tags/raw/
---
Template tags tell Liquid where to disable processing for comments or non-Liquid markup, and how to establish relations among template files.
## comment
Allows you to leave un-rendered code inside a Liquid template. Any text within the opening and closing `comment` blocks will not be printed, and any Liquid code within will not be executed.
<p class="code-label">Input</p>
```liquid
{% raw %}
{% assign verb = "turned" %}
{% comment %}
{% assign verb = "converted" %}
{% endcomment %}
Anything you put between {% comment %} and {% endcomment %} tags
is {{ verb }} into a comment.
{% endraw %}
```
<p class="code-label">Output</p>
```liquid
{% assign verb = "turned" %}
{% comment %}
{% assign verb = "converted" %}
{% endcomment %}
Anything you put between {% comment %} and {% endcomment %} tags
is {{ verb }} into a comment.
```
## raw
Temporarily disables tag processing. This is useful for generating certain content that uses conflicting syntax, such as [Mustache](https://mustache.github.io/) or [Handlebars](https://handlebarsjs.com/).
<p class="code-label">Input</p>
```liquid
{{ "%7B%25+raw+%25%7D" | url_decode }}{% raw %}
In Handlebars, {{ this }} will be HTML-escaped, but {{{ that }}} will not.
{% endraw %}{{ "%7B%25+endraw+%25%7D" | url_decode }}
```
<p class="code-label">Output</p>
```text
{% raw %}
In Handlebars, {{ this }} will be HTML-escaped, but {{{ that }}} will not.
{% endraw %}
```
## liquid {%- include version-badge.html version="5.0.0" %}
Encloses multiple tags within one set of delimiters, to allow writing Liquid logic more concisely.
```liquid
{% raw %}
{% liquid
case section.blocks.size
when 1
assign column_size = ''
when 2
assign column_size = 'one-half'
when 3
assign column_size = 'one-third'
else
assign column_size = 'one-quarter'
endcase %}
{% endraw %}
```
Because any tag blocks opened within a `liquid` tag must also be closed within the same tag, use [`echo`](#echo) to output data.
## echo {%- include version-badge.html version="5.0.0" %}
Outputs an expression in the rendered HTML. This is identical to wrapping an expression in `{% raw %}{{{% endraw %}` and `{% raw %}}}{% endraw %}`, but works inside [`liquid`](#liquid) tags and supports [filters]({{ "/basics/introduction/#filters" | prepend: site.baseurl }}).
<p class="code-label">Input</p>
```liquid
{% raw %}
{% liquid
for product in collection.products
echo product.title | capitalize
endfor %}
{% endraw %}
```
<p class="code-label">Output</p>
```text
Hat Shirt Pants
```
## render {%- include version-badge.html version="5.0.0" %}
Insert the rendered content of another template within the current template.
```liquid
{% raw %}
{% render "template-name" %}
{% endraw %}
```
Note that you don't need to write the file's `.liquid` extension.
The code within the rendered template does **not** automatically have access to the variables assigned using [variable tags]({{ "/tags/variable/" | prepend: site.baseurl }}) within the parent template. Similarly, variables assigned within the rendered template cannot be accessed by code in any other template.
## render (parameters)
Variables assigned using [variable tags]({{ "/tags/variable/" | prepend: site.baseurl }}) can be passed to a template by listing them as parameters on the `render` tag.
```liquid
{% raw %}
{% assign my_variable = "apples" %}
{% render "name", my_variable: my_variable, my_other_variable: "oranges" %}
{% endraw %}
```
One or more objects can be passed to a template.
```liquid
{% raw %}
{% assign featured_product = all_products["product_handle"] %}
{% render "product", product: featured_product %}
{% endraw %}
```
### with
A single object can be passed to a template by using the `with` and optional `as` parameters.
```liquid
{% raw %}
{% assign featured_product = all_products["product_handle"] %}
{% render "product" with featured_product as product %}
{% endraw %}
```
In the example above, the `product` variable in the rendered template will hold the value of `featured_product` from the parent template.
### for
A template can be rendered once for each value of an enumerable object by using the `for` and optional `as` parameters.
```liquid
{% raw %}
{% assign variants = product.variants %}
{% render "product_variant" for variants as variant %}
{% endraw %}
```
In the example above, the template will be rendered once for each variant of the product, and the `variant` variable will hold a different product variant object for each iteration.
When using the `for` parameter, the [`forloop`](https://shopify.dev/docs/themes/liquid/reference/objects/for-loops) object is accessible within the rendered template.
## include
_The `include` tag is deprecated; please use [`render`](#render) instead._
Insert the rendered content of another template within the current template.
```liquid
{% raw %}
{% include "template-name" %}
{% endraw %}
```
The `include` tag works similarly to the [`render`](#render) tag, but it allows the code inside of the rendered template to access and overwrite the variables within its parent template. It has been deprecated because the way that it handles variables reduces performance and makes Liquid code harder to both read and maintain.
Note that when a template is rendered using the [`render`](#render) tag, the `include` tag cannot be used within the template.