Modyo Docs

# Liquid markup

Liquid is a template engine which was written with very specific requirements:

  • It has to have beautiful and simple markup. Template engines which don't produce good looking markup are no fun to use.
  • It needs to be non-evaluable and safe. Liquid templates are made so that users can edit them. You don't want to run code on your server which your users wrote.
  • It has to be stateless. Compile and render steps have to be separate so that the expensive parsing and compiling can be done once and later on you can just render it passing in a hash with local variables and objects.

# Why use Liquid?

  • You want to allow your users to edit the appearance of your application but don't want them to run insecure code on your server.
  • You want to render templates directly from a database.
  • You like smarty (PHP) style template engines.
  • You need a template engine which does HTML just as well as emails.
  • You don't like the markup of your current templating engine.

# What does it look like?

<ul id="products">
  {% for product in products %}
    <li>
      <h2>{{ product.name }}</h2>
      Only {{ product.price | price }}

      {{ product.description | prettyprint | paragraph }}
    </li>
  {% endfor %}
</ul>

# How to use Liquid

There are two types of markup in Liquid: Output and Tag.

  • Output markup (which may resolve to text) is surrounded by
{{ matched pairs of curly brackets (ie, braces) }}
  • Tag markup (which cannot resolve to text) is surrounded by
{% matched pairs of curly brackets and percent signs %}

# Output

An output statement is a set of double curly braces containing an expression; when the template is rendered, it gets replaced with the value of that expression.

Here is a simple example of output:

Hello {{name}}
Hello {{user.name}}
Hello {{ 'tobi' }}

# Expressions and Variables

Expressions are statements that have values. Liquid templates can use expressions in several places; most often in output statements, but also as arguments to some tags or filters.

Liquid accepts the following kinds of expressions:

  • Variables. The most basic type of expression is just the name of a variable. Liquid variables are named like Ruby variables: they must contain alphanumeric characters and underscores, should always start with a letter, and not have any kind of leading symbol (that is, they must look like var_name, not $var_name).
  • Array or hash access. If you have an expression (usually a variable) whose value is an array or hash, you can use a single value from that array/hash as follows:
    • my_variable[<KEY EXPRESSION>] — The name of the variable, followed immediately by square brackets containing a key expression.
      • For arrays, the key must be a literal integer or an expression that resolves to an integer.
      • For hashes, the key must be a literal quotation string or an expression that resolves to a string.
    • my_hash.key — Hashes also allow a shorter "dot" notation, where the name of the variable is followed by a period and the name of a key. This only works with keys that don't contain spaces, and (unlike the square bracket notation) does not allow the use of a key name stored in a variable.
    • Note: if the value of an access expression is also an array or hash, you can access values from it in the same way, and can even combine the two methods. (For example, site.posts[34].title.)
  • Array first and last. If you have an expression whose value is an array, you can follow it with .first or .last to resolve to its first or last element.
  • Array or hash size. If you have an expression whose value is an array or hash, you can follow it with .size to resolve to the number of elements in the original expression, as an integer.
  • Strings. Literal strings must be surrounded by double or single quotes ("my string" or 'my string'). There is no difference; neither style allows variable interpolation.
  • Integers. Integers must not be quoted.
  • Booleans and nil. The literal values true, false, and nil.

To build an input array, you cannot do it in a control statement. You need to do it in a separate statement and then use that as a variable in a control statement.

# Filters

Output markup can take filters, which modify the result of the output statement. You can invoke filters by following the output statement's main expression with:

  • A pipe character (|)
  • The name of the filter
  • Optionally, a colon (:) and a comma-separated list of additional parameters to the filter. Each additional parameter must be a valid expression, and each filter pre-defines the parameters it accepts and the order in which they must be passed.

Filters can also be chained together by adding additional filter statements (starting with another pipe character). The output of the previous filter will be the input for the next one.

Hello {{ 'tobi' | upcase }}
Hello tobi has {{ 'tobi' | size }} letters!
Hello {{ '*tobi*' | textilize | upcase }}
Hello {{ 'now' | date: "%Y %h" }}

Under the hood, a filter is a Ruby method that takes one or more parameters and returns a value. Parameters are passed to filters by position: the first parameter is the expression preceding the pipe character, and additional parameters can be passed using the name: arg1, arg2 syntax described above.

# Standard filters

  • append - Add a string e.g. {{'foo' | append: 'bar'}} # => 'foobar'
  • asset_url - Generates the URL for an Asset object with a determined size, e.g. . Also, can generate the URL of a CSS or JavaScript template, e.g. my-css or my-js.
  • capitalize - Capitalize the entry sentence
  • ceil - Rounds up a decimal number to the next integer, e.g. {{4.6 | ceil}} # => 5
  • date - Format a date (syntax reference (opens new window))
  • default - Returns the given variable unless it is null or empty string, then returns the given value, e.g. {{undefined_variable | default: "Default value"}} # => "Default value"
  • divided_by - Division of integers e.g. {{10 | divided_by: 3}} # => 3
  • downcase - Convert an input string to lowercase
  • escape_once - Returns an escape version of html without affecting existing escape entities
  • escape - Escape html to a string
  • first - Get the first element of the last array
  • floor - Rounds a decimal number down to the nearest integer, e.g. {{4.6 | floor}} # => 4
  • join - Join elements of the array with a certain character between them.
  • last - Get the last element of the last array
  • lstrip - Remove all blank spaces from the beginning of a string
  • map - Map/collect an array on a given property.
  • minus - Subtract e.g. {{4 | minus: 2}} # => 2
  • module - Rest e.g. {{3 | module: 2}} # => 1
  • newline_to_br - Replace each new line (\ n) with html space
  • plus - Sum e.g. {{'1' | plus: '1'}} # => 2, {{1 | plus: 1}} # => 2
  • prepend - Precede a string e.g. {{'bar' | prepend: 'foo'}} # => 'foobar'
  • remove_first - Eliminates the first incident e.g. {{'barbar' | remove_first: 'bar'}} # => 'bar'
  • remove - Eliminates all incidents e.g. {{'foobarfoobar' | remove: 'foo'}} # => 'barbar'
  • replace_first - Replaces the first incident e.g. {{'barbar' | replace_first: 'bar', 'foo'}} # => 'foobar'
  • replace - Replace all incidents e.g. {{'foofoo' | replace: 'foo', 'bar'}} # => 'barbar'
  • reverse - Reverse the given arrangement.
  • round - Round to the nearest whole number or to the specified number of decimals e.g. {{4.5612 | round: 2}} # => 4.56
  • rstrip - Remove all blank spaces from the end of a string
  • script_tag - Generates a <script> HTML tag for a JavaScript template, taking a URL and attr: 'value' attributes as parameters, e.g. my-js-url => <script src='my-js-url' type='text/javascript' async='async' defer='defer'></script>
  • size - Return the size of an array or string
  • slice - Divide a string. Take a offset and a length, e.g. {{" hello "| slice: -3, 3}} # => llo
  • sort - Sort array items
  • split - Split a string into a matching pattern e.g. {{"a ~ b" | split: "~"}} # => ['a', 'b']
  • strip_html - Remove html from the string
  • strip_newlines - Remove all new lines (\ n) from the string
  • strip - Removes all blank spaces at both ends of the string.
  • stylesheet_tag - Generates a <link> HTML tag for a CSS template, taking a URL and attr: 'value' attributes as parameters, e.g. my-css-url => <link href='my-css-url' rel='stylesheet' type='text/css' media='screen' title='color style' />
  • times - Multiply e.g. {{5 | times: 4}} # => 20
  • truncate - Restrict a string to x characters. It also accepts a second parameter that will be added to the string e.g. {{'foobarfoobar' | truncate: 5, '.' }} # => 'foob.'
  • truncatewords - Restrict a string to x words
  • uniq - Removes duplicate elements from an array, optionally using a specific property to check its uniqueness.
  • upcase - Convert an input string to uppercase
  • url_encode - Encode a string to URL

# Tags

Tags (tags) are used for template logic. Here is a list of currently supported tags:

  • assign - Assigns a value to a variable
  • capture - Tag block that captures text to a variable.
  • case - Tag block, case standard statement.
  • comment - Block tag, comment on the text in the block.
  • cycle - Cycle is generally used within a loop to toggle between values, such as colors or DOM classes.
  • for - Loop for
  • break - Exits a loop
  • continue Skip the remaining code in the current loop and continue with the next loop.
  • if - Standard if/else block.
  • include - Includes another template; useful for partials
  • raw - Temporarily disable tag processing to avoid syntax conflicts.
  • unless - Copy of the if statement.

# Comments

Any content that is written between the tags {% comment %} and {% endcomment %} will be converted to a comment.

We made 1 million dollars {% comment %} in losses {% endcomment %} this year

# Raw

Raw is used to temporarily disable the tag process. This is useful for generating content (eg, Mustache, Handlebars) that can use conflicting syntax with other elements.

{% raw %}
  In Handlebars, {{this}} will be HTML-escaped, but {{{{that}}} will not.
{% endraw%}

# If/Else

The if/else statements should be known from other programming languages. Liquid implements them with the following tags:

  • {% if <CONDITION>%} ... {% endif %} - Attach a section of the template that will only be executed if the condition is true.
  • {% elsif <CONDITION> %} - Can optionally be used within an if .... endif block. Specifies another condition; If the initial if fails, Liquid tests the elsif, and if it passes, executes the next section of the template. Any number of elsif statements can be used in an if/else statement.
  • {% else %} - Can be used within an if ... endif block, after any elsif tag. If all the above conditions fail, Liquid will execute the template section following the else tag.
  • {% unless <CONDITION> %} ... {% endunless %} - The reverse of an if statement. Do not use elsif or else with an unless statement.

The condition of an if,elsif or unless tag must be a normal Liquid expression or a comparison using Liquid expressions. Note that relational operators are implemented using tags similar to if; they don't work anywhere else in Liquid.

The available relational operators are:

  • ==, !=, and < > - equal and unequal (the last two are synonyms)
    • There is a special secret value "empty" (without quotes) to compare arrays; The comparison is true if the array has no items.
  • <, <=, >, >= - less/greater than
  • contains - a wrapper around Ruby's include? method, which is implemented in strings, arrays and hashes. If the left argument is a string and the right is not, this will convert the right to a string.

The available Boolean operators are:

  • and
  • or

Note that there is NO no operator, and you CANNOT use parentheses to control the order of operations, as the precedence of each operator will appear unspecified. When in doubt, use nested if statements.

Liquid expressions are tested to determine their "truthiness" in similar to Ruby:

  • true is true
  • false is false.
  • Any string is true, including an empty string.
  • Any array is true.
  • Any hash is true.
  • Any non-existent/null value (as a missing part of a hash) is false.
{% if user %}
  Hello {{ user.name }}
{% endif %}

# Same as above
{% if user!=null %}
  Hello {{ user.name }}
{% endif %}

{% if user.name == 'tobi' %}
  Hello tobi
{% elsif user.name == 'bob' %}
  Hello bob
{% endif%}

{% if user.name == 'tobi' or user.name == 'bob' %}
  Hello tobi or bob
{% endif %}

{% if user.name == 'bob' and user.age > 45 %}
  Hello old bob
{% endif %}

{% if user.name != 'tobi' %}
  Hello non-tobi
{% endif %}

# Same as above
{% unless user.name == 'tobi' %}
  Hello non-tobi
{% endunless %}

# Check for the size of an array
{% if user.payments == empty %}
   you never paid!
{% endif %}

{% if user.payments.size > 0%}
   you paid!
{% endif %}

{% if user.age> 18 %}
   Login here
{% else %}
   Sorry, you are too young
{% endif %}

# array = 1,2,3
{% if array contains 2 %}
   array includes 2
{% endif %}

# string = 'hello world'
{% if string contains 'hello' %}
   string includes 'hello'
{% endif %}

# Case/when

If you need to evaluate multiple conditions, you can use the "case" statement:

{% case condition %}
{% when 1 %}
hit 1
{% when 2 or 3 %}
hit 2 or 3
{% else %}
... else ...
{% endcase %}

Example:

{% case template %}

{% when 'label' %}
     //{{ label.title }}
{% when 'product' %}
     //{{ product.vendor | link_to_vendor }}/{{ product.title }}
{% else%}
     //{{ page_title }}
{% endcase %}

# Cycle

You often have to alternate between different colors or similar tasks. Liquid has built-in support for such operations, using the cycle tag.

{% cycle 'one', 'two', 'three'%}
{% cycle 'one', 'two', 'three'%}
{% cycle 'one', 'two', 'three'%}
{% cycle 'one', 'two', 'three'%}

will result in

one
two
three
one

If no name is provided for the cycle group, then it is assumed that multiple Calls with the same parameters are a group.

If you want to have full control over the cycle groups, you can optionally specify The name of the group. This can even be a variable.

{% cycle 'group 1': 'one', 'two', 'three'%}
{% cycle 'group 1': 'one', 'two', 'three'%}
{% cycle 'group 2': 'one', 'two', 'three'%}
{% cycle 'group 2': 'one', 'two', 'three'%}

will result in

one
two
one
two

# For Loop

Liquid allows for loops over collections:

{% for item in array %}
  {{ item }}
{% endfor %}

# Types of collections allowed

For loops can iterate over arrays, hashes and integer ranges.

When iterating over a hash, element[0] contains the key, and element[1] contains the value:

{% for item in hash %}
  {{ item [0] }}: {{ item [1] }}
{% endfor %}

Instead of looping over an existing collection, you can also loop through a range of numbers. The ranges appear as (1..10)—parentheses that contain an initial value, two points and an end value. The initial and final values must be integers or expressions that are resolved to whole numbers.

# if item.quantity is 4 ...
{% for i in (1..item.quantity) %}
  {{ i }}
{% endfor %}
# results in 1,2,3,4

# Break and continue

You can exit a loop early with the following tags:

  • {% continue %} - immediately ends the current iteration, and continues the "for" loop with the following value.
  • {% break %} - immediately ends the current iteration, then exits the "for" loop.

Both are only useful when combined with something like an "if" statement.

{% for page in pages %}
# Skip anything in the hidden_pages array, but keep looping over the rest of the values
{% if hidden_pages contains page.url %}
    {% continue %}
{% endif %}
# If it's not hidden, print it.
* [page.title](page.url)
{% endfor %}

{% for page in pages %}
* [page.title](page.url)
# After we reach the "cutoff" page, stop the list and get on with whatever's after the "for" loop:
{% if cutoff_page == page.url %}
    {% break%}
{% endif %}
{% endfor %}

# Help variables

During each for loop, the following help variables are available for additional style needs:

forloop.length # => length of the entire for loop
forloop.index # => index of the current iteration
forloop.index0 # => index of the current iteration (zero based)
forloop.rindex # => how many items are still left?
forloop.rindex0 # => how many items are still left? (zero based)
forloop.first # => is this the first iteration?
forloop.last # => is this the last iteration?

# Optional arguments

There are several optional arguments in the for tag that can influence the elements you receive in your loop and in the order in which they appear:

  • limit: <INTEGER> allows you to restrict the amount of objects to obtain.
  • offset: <INTEGER> allows you to start the collection with the nth item.
  • reversed iterates over the collection from the last to the first.

Restriction elements:

# array=[1,2,3,4,5,6]
{% for item in array limit: 2 offset: 2 %}
  {{ item }}
{% endfor %}
# results in 3,4

Loop Inversion:

{% for item in collection reversed %} {{ item }} {% endfor %}

A for loop can take an optional else clause to display a block of text when there are no items in the collection:

# items => []
{% for item in items %}
   {{ item.title }}
{% else %}
   There are no items!
{% endfor %}

# Variable assignment

You can store data in your own variables and use them in output tags or any other tags you wish. The easiest way to create a variable is with the assign tag with simple syntax:

{% assign name = 'freestyle' %}

{% for t in collections.tags %} {% if t == name %}
  <p> Freestyle! </p>
{% endif %} {% endfor %}

Another way to do this would be to assign true/false values to the variable:

{% assign freestyle = false %}

{% for t in collections.tags %} {% if t == 'freestyle' %}
  {% assign freestyle = true %}
{% endif %} {% endfor %}

{% if freestyle %}
  <p> Freestyle! </p>
{% endif %}

If you want to combine several strings into one and save it in one variable, you can do it with the capture tag, which “captures” whatever is displayed inside, and then assigns the captured value to the given variable.

  {% capture attribute_name %} {{item.title | handleize}} - {{i}} - color {% endcapture%}

  <label for="{{attribute_name}}"> Color: </label>
  <select name="attributes [{{attribute_name}}]" id="{{attribute_name}}">
    <option value="red"> Red </option>
    <option value="green"> Green </option>
    <option value="blue"> Blue </option>
  </select>

# Drops

Modyo has drops available for different contexts within which you can find drops for the account, content, channels and customers.

# Account Drops

The drops available globally are:

account:
  - url
  - host
  - disable_modyo_credentials
  - google_key
  - oauth2_callback_url
  - oidc_callback_url

# Content drops

The drops available for content are:

space:
  - entries
  - types
  - name
type:
  - entries
  - fields
  - name
entry:
  - space
  - category
  - type
  - type_uid
  - tags
  - account_url
  - url
  - author
  - meta
  - fields
field:
  - name
  - type
location:
  - location_street
  - latitude
  - longitude
category:
  - id
  - slug
  - name
  - url
  - parent
  - children
  - siblings
  - products_url
  - support_url
  - networks_url
  - profiles_url
  - posts_url
  - promotions_url
  - albums_url
  - videos_url
  - files_url
  - audio_url
  - places_url
asset:
  - url
  - thumbnail_url
  - uuid
  - data_file_name
  - name
  - content_type
  - title
  - alt
  - size
  - description
audio_asset:
  - url
file_asset:
  - url
  - thumbnail_url
  - image_thumbnail_url
  - pdf_thumbnail_url
  - is_image
  - is_video
  - is_audio
  - is_pdf
  - is_another
  - temp_url
video_asset:
  - url
  - thumbnail_url

# Channels drops

The drops available for channels are:

site:
  - breadcrumb
  - categories
  - csrf_meta_tag
  - url
  - menu_items
  - account_url
  - current_year
  - manifest_url
  - sw_enabled
  - sw_url
  - sw_scope
  - add_parent_breadcrumb
site_search:
  - have_results
  - results
  - have_less_relevant_results
request:
  - user_agent
  - host
  - domain
  - protocol
  - url
  - path
  - interact_url
  - refresh_url
  - comments_url
  - is_app_shell
user_agent:
  - initialize
  - browser
  - browser_version
  - platform
  - platform_version
  - agent
  - is_modyo_shell
page:
  - grid
  - name
  - content
  - title
  - excerpt
  - name
  - url
  - parent
  - description
menu:
  - items
menu_item:
  - label
  - child_items
  - url
  - parameterized_label
  - category
  - position
  - target
widget:
  - id
  - cache_key
  - type
  - created_at
  - css_class
  - width
  - name
  - use_default_title
  - title
  - resolve_type
  - uuid
  - wid
  - permanent_cache
rich_text_widget:
  - html
custom_widget:
  - manager_uuid
  - version
text_widget:
  - html
content_list_widget:
  - show_caption
  - entries
  - context_params
  - space_id
  - type_uid
grid:
  - id
  - cache_key
  - resolve_type
full_three_cols_grid:
  - main_widgets
  - col1_widgets
  - col2_widgets
  - col3_widgets
side_right_three_cols_grid:
  - main_widgets
  - side_right_widgets
  - col1_widgets
  - col2_widgets
  - col3_widgets
side_left_grid:
  - main_widgets
  - side_left_widgets
side_left_one_col_grid:
  - main_widgets
  - side_left_widgets
  - full_widgets
side_right_one_col_grid:
  - main_widgets
  - side_right_widgets
  - full_widgets
full_grid:
  - main_widgets
full_two_cols_grid:
  - main_widgets
  - col1_widgets
  - col2_widgets
side_right_grid:
  - main_widgets
  - side_right_widgets
side_left_three_cols_grid:
  - main_widgets
  - side_left_widgets
  - col1_widgets
  - col2_widgets
  - col3_widgets

# Customers drops

The drops available for customers are:

- user:
  - access_token
  - age
  - avatar
  - birth_at
  - change_password_url
  - custom_fields
  - email
  - external_access_token
  - external_user_id
  - female_sex_value
  - first_name
  - genders
  - generated_password
  - id
  - initials
  - last_name
  - male_sex_value
  - member_since
  - name
  - notifications
  - profile_url
  - sex
  - target_names
  - targets
  - undefined_sex_value
  - unread_notifications
  - unread_notifications_count
  - username
  - uuid
notification:
  - subject
  - body
  - sent_at
  - url
  - opened
- user_agent:
  - agent
  - browser
  - browser_version
  - initialize
  - is_modyo_shell
  - platform
  - platform_version
- user_session:
  - email
  - password
- target:
  - id
  - name
- form:
  - slug
- form_response:
  - description
  - name
  - parse_answer
  - parse_answers
  - questions
- question:
  - allow_alternatives
  - alternatives
  - form
  - id
  - label
- alternative:
  - id
  - question
- answer:
  - alternative
  - dynamic_target_url
  - edit_url
  - id
  - question
  - response
  - text_field
  - type

← Users →