Test Page
Just for test …
Liquid for Designers
https://github.com/shopify/liquid/wiki/liquid-for-designers
There are two types of markup in Liquid: Output and Tag.
- Output markup (which may resolve to text) is surrounded by
- Tag markup (which cannot resolve to text) is surrounded by
Output
Here is a simple example of Output:
Advanced output: Filters
Output markup takes filters. Filters are simple methods. The first parameter is always the output of the left side of the filter. The return value of the filter will be the new left value when the next filter is run. When there are no more filters, the template will receive the resulting string.
Standard Filters
date
- reformat a date syntax referencecapitalize
- capitalize words in the input sentencedowncase
- convert an input string to lowercaseupcase
- convert an input string to uppercasefirst
- get the first element of the passed in arraylast
- get the last element of the passed in arrayjoin
- join elements of the array with certain character between themsort
- sort elements of the arraymap
- map/collect an array on a given propertysize
- return the size of an array or stringescape
- escape a stringescape_once
- returns an escaped version of html without affecting existing escaped entitiesstrip_html
- strip html from stringstrip_newlines
- strip all newlines (\n) from stringnewline_to_br
- replace each newline (\n) with html breakreplace
- replace each occurrence e.g.barbar #=> 'barbar'
replace_first
- replace the first occurrence e.g.foobar #=> 'foobar'
remove
- remove each occurrence e.g.barbar #=> 'barbar'
remove_first
- remove the first occurrence e.g.bar #=> 'bar'
truncate
- truncate a string down to x characterstruncatewords
- truncate a string down to x wordsprepend
- prepend a string e.g.foobar #=> 'foobar'
append
- append a string e.g.foobar #=> 'foobar'
minus
- subtraction e.g.2 #=> 2
plus
- addition e.g.2 #=> '11'
,2 #=> 2
times
- multiplication e.g20 #=> 20
divided_by
- division e.g.5 #=> 5
split
- split a string on a matching pattern e.g.a~b #=> ['a','b']
modulo
- remainder, e.g.1 #=> 1
Tags
Tags are used for the logic in your template. New tags are very easy to code, so I hope to get many contributions to the standard tag library after releasing this code.
Here is a list of currently supported tags:
- assign - Assigns some value to a variable
- capture - Block tag that captures text into a variable
- case - Block tag, its the standard case…when block
- comment - Block tag, comments out the text in the block
- cycle - Cycle is usually used within a loop to alternate between values, like colors or DOM classes.
- for - For loop
- if - Standard if/else block
- include - Includes another template; useful for partials
- raw - temporarily disable tag processing to avoid syntax conflicts.
- unless - Mirror of if statement
Comments
Comment is the simplest tag. It just swallows content.
Raw
Raw temporarily disables tag processing. This is useful for generating content (eg, Mustache, Handlebars) which uses conflicting syntax.
{% raw %}
In Handlebars, {{ this }} will be HTML-escaped, but {{{ that }}} will not.
{% endraw %}
If / Else
if / else
should be well-known from any other programming language.
Liquid allows you to write simple expressions in the if
or unless
(and
optionally, elsif
and else
) clause:
Case Statement
If you need more conditions, you can use the case
statement:
Example:
Cycle
Often you have to alternate between different colors or similar tasks. Liquid
has built-in support for such operations, using the cycle
tag.
If no name is supplied for the cycle group, then it’s assumed that multiple calls with the same parameters are one group.
If you want to have total control over cycle groups, you can optionally specify the name of the group. This can even be a variable.
For loops
Liquid allows for
loops over collections:
During every for
loop, the following helper variables are available for extra
styling needs:
There are several attributes you can use to influence which items you receive in your loop
limit:int
lets you restrict how many items you get.
offset:int
lets you start the collection with the nth item.
Reversing the loop
Instead of looping over an existing collection, you can define a range of numbers to loop through. The range can be defined by both literal and variable numbers:
Variable Assignment
You can store data in your own variables, to be used in output or other tags as
desired. The simplest way to create a variable is with the assign
tag, which
has a pretty straightforward syntax:
Another way of doing this would be to assign true / false
values to the
variable:
If you want to combine a number of strings into a single string and save it to
a variable, you can do that with the capture
tag. This tag is a block which
“captures” whatever is rendered inside it, then assigns the captured value to
the given variable instead of rendering it to the screen.