Liquid

js_encode filter

The js_encode filter encodes a string for javascript.

Input

my_value = Hello world " ' "

{{ my_value | js_encode }}

Output

Hello world /" /' /" 

httpcontext_set_item filter

The httpcontext_set_item filter is used to set a value in the HttpContext.Items

Usage

{{ "Key" | httpcontext_set_item: "Value" }}

LocalizedText (StatCan.OrchardCore.LocalizedText)

Use the localize liquid filter to reference and output a value that matches the current culture and name provided.

Examples

Data:

[
  {
    "Name": "my_value",
    "LocalizedItems": [
      {
        "Culture":"en",
        "Value":"Some English Value"
      },
      {
        "Culture":"fr",
        "Value":"Some French Value"
      }
    ]
  }
]

Input

{{ "my_value" | localize }}

{{ Model.ContentItem | localize: "my_value"}}

Output

Some English Value

Some English Value

You can also pass parameters to your values

Data:

[
  {
    "Name": "my_parameterized_value",
    "LocalizedItems": [
      {
        "Culture":"en",
        "Value":"Some {0} English Value"
      },
      {
        "Culture":"fr",
        "Value":"Some {0} French Value"
      }
    ]
  }
]

Input

{{ "my_parameterized_value" | localize: "parameterized" }}

{{ Model.ContentItem | localize: "my_parameterized_value", "parameterized" }}

Output

Some parameterized English Value

Some parameterized English Value

if you want to render html, you need to | raw

Data:

[
  {
    "Name": "my_html_value",
    "LocalizedItems": [
      {
        "Culture":"en",
        "Value":"<span>Some English Value</span>"
      },
      {
        "Culture":"fr",
        "Value":"<span>Some French Value</span>"
      }
    ]
  }
]

Input

{{ "my_html_value" | localize }}

{{ Model.ContentItem | localize: "my_html_value" | raw }}

Output

<span>bold value</span>

<span>Some English Value</span>

GitHub (StatCan.OrchardCore.GitHub)

Here are some liquid filters provided by the GitHub module.

tokenName refers to the name of the token you added to the github settings.

github_pr filter

Returns the PullRequest object for the specified pull request number.

{{ 123 | github_pullrequest: "owner", "repo", "tokenName" }}

github_pr_reviewcomments filter

Returns a list of PullRequestReviewComment object for the specified pull request number. This returns the comments related to PR reviews. Use the github_comments filter to get pr discussions.

{{ 123 | github_pullrequest_comments: "owner", "repo", "tokenName" }}

github_issue filter

Returns the Issue object for the specified issue number.

{{ 123 | github_issue: "owner", "repo", "tokenName" }}

github_comments filter

Returns a list of IssueComment for the specified issue / pull request number.

{{ 123 | github_comments: "owner", "repo", "tokenName" }}

User filters

users_by_role filter

Returns a list of Users that have the role(s) passed as a parameter of the filter

{% assign users = "Editor,Administrator" | split:',' | users_by_role %}

{% for user in users%}
  {{user.Email}}
{% endfor %}

--

{% assign users = "Editor"  | users_by_role %}

{% for user in users%}
  {{user.Email}}
{% endfor %}

Shortcodes filters

to_html_attributes filter

Convert shortcode arguments to html attributes. The first argument of the filter is a comma delimited whitelist of arguments to convert. If no whitelist is provided, all arguments will be output.

<!-- This is the liquid in the Shortcode template -->
<v-container {{ Args | to_html_attributes: "id,fluid,tag" | raw }}>{{ Content | raw }}</v-container>

--

<!-- This is the shortcode in your html template -->
[container id='my-id' other='other']Some html content[/container]

--

<!-- This is the output -->
<v-container id="my-id">Some html content</v-container>

---

Last update: September 10, 2021