Liquid Tags: Insites

background

Invokes code within the tag asynchronously, in the background. You will only have access to variables you explicitly pass to the background tag. The context object is available by default, but with limitations - you need to explicitly pass page/layout metadata if you want to use it, as well as device and constants.

Params

Examples

cache

Checks if there's a string cached for the given key. If yes, it just returns the value without processing anything inside the cache tag, otherwise, it executes code, and stores the result in the cache. When you hit the page with such code for the first time, the code will be executed and hence it will iterate through the loop and generate random strings. However, then the result of the block will be cached and all the following requests within 20 seconds would not invoke the code - instead, it would just take the value from the cache. The output will not change. When the cache expires, the code will be evaluated again, producing another set of random strings. The cache is automatically invalidated if any changes are applied to any view/translation.

Params

Examples

content_for

Stores a block of markup in an identifier for later use. Render it later with yield tag.

Params

Examples

context

Set locale in context to a given language.

Params

Examples

export

Makes variables defined inside partial accessible anywhere via context.exports.`namespace`

Params

Examples

form

Generates an HTML form element for a resource. Use it inside a form file in the app/forms directory. Inside the tag you can use the `form_builder` variable.

Params

Examples

function

Allows to store a variable returned by a partial. Partial needs to return data with `return` tag. All variables needs to be passed explicitly to function. Variables from upper scope are not visible in function. *Note:* `context` is not available inside the function partial unless explicitly passed as a variable.

Examples

graphql

Executes a GraphQL query stored in a file, or a GraphQL query written inline. All arguments provided to the tag will be passed to GraphQL. It returns a hash with the data or the errors that occurred (for example, variable type mismatch, required variable not provided, syntax error) etc.

Params

Examples

hash_assign

Deprecated. Use assign instead. assign writes into a hash with dot or bracket notation, for example . Code that uses hash_assign works, but use assign in new code.

Examples

include_form

This tag should be used to render forms defined in forms directory.

Params

Examples

log

Prints information to the instance logs. To view logs, run in your project folder and open http://localhost:3030/logs. To see logs in the terminal, run .

Params

Examples

parse_json

Parses a JSON string into a hash or array. For JSON you write in the template, use an assign literal instead: . Keep parse_json for a JSON string that arrives at runtime, such as an API response.

Params

Examples

print

Print variable, skipping any additional sanitization. It provides a way to display a variable which consists of both safe and unsafe html. Warning: Do not use it with data entered by users as it is gonna cause XSS.

Params

Examples

redirect_to

Redirects browser to target

Params

Examples

response_headers

Allows you to set additional HTTP headers for the response.

Params

Examples

response_status

Allows you to set HTTP status for the response. Default 200.

Params

Examples

return

Used inside a partial invoked by a function tag to return a variable.

Examples

session

Stores data during user's session Sets field of given name to given value in context.session.

Examples

sign_in

Sign in user.

Params

Examples

spam_protection

Generates HTML for spam protection. Supports three strategies: recaptcha_v2 and recaptcha_v3 (Google reCAPTCHA) and hcaptcha (hCaptcha).

Params

Examples

theme_render_rc

Lets you set search paths for theme partials with the theme_search_paths property in app/config.yml. For example:

Examples

transaction

Runs all database writes inside the block as one transaction. If one fails, all are rolled back. The timeout parameter (in seconds) aborts and rolls back a block that runs too long. Variables inside and outside the block are shared. A background job scheduled inside the block is queued only after the transaction commits.

Params

Examples

rollback

Rolls back the current transaction by hand. Use it inside a transaction block.

Examples

try

Catches errors. This is most useful with in app/config.yml. try_rc is another spelling of the same tag.

Examples

yield

Execute code wrapped inside content_for

Params

Examples