A Liquid engine implementation for both Node.js and browsers, with all shopify/liquid features. Formerly known as shopify-liquid.
Live Demo: http://harttle.com/liquidjs/
The Liquid template engine is implemented in Ruby originally, which is used by Jekyll and Github Pages.
Features:
- A wide range of filters and tags
- Easy tag/filter registration, allows async tags
- any-promise
API Reference:
- Builtin Tags: https://github.com/harttle/liquidjs/wiki/Builtin-Tags
- Builtin Filters: https://github.com/harttle/liquidjs/wiki/Builtin-Filters
- Operators: https://github.com/harttle/liquidjs/wiki/Operators
- Whitespace Control: https://github.com/harttle/liquidjs/wiki/Whitespace-Control
Installation:
npm install --save liquidjs
Parse and Render:
var Liquid = require('liquidjs');
var engine = Liquid();
engine.parseAndRender('{{name | capitalize}}', {name: 'alice'})
.then(function(html){
// html === 'Alice'
});
Caching templates:
var tpl = engine.parse('{{name | capitalize}}');
engine.render(tpl, {name: 'alice'})
.then(function(html){
// html === 'Alice'
});
var engine = Liquid({
root: path.resolve(__dirname, 'views/'), // dirs to lookup layouts/includes
extname: '.liquid' // the default extname used for layouts/includes
});
engine.renderFile("hello.liquid", {name: 'alice'})
.then(function(html){
// html === 'Alice'
});
// equivalent to:
engine.renderFile("hello", {name: 'alice'})
.then(function(html){
// html === 'Alice'
});
The full list of options for Liquid()
is listed as following:
-
root
is a directory or an array of directories to resolve layouts and includes, as well as the filename passed in when calling.renderFile()
. If an array, the files are looked up in the order they occur in the array. Defaults to["."]
-
extname
is used to lookup the template file when filepath doesn't include an extension name. Eg: setting to".html"
will allow including file by basename. Defaults to""
. -
cache
indicates whether or not to cache resolved templates. Defaults tofalse
. -
strict_filters
is used to enable strict filter existence. If set tofalse
, undefined filters will be rendered as empty string. Otherwise, undefined filters will cause an exception. Defaults tofalse
. -
strict_variables
is used to enable strict variable derivation. If set tofalse
, undefined variables will be rendered as empty string. Otherwise, undefined variables will cause an exception. Defaults tofalse
. -
trim_tag_right
is used to strip blank characters (including\t
, and\r
) from the right of tags ({% %}
) until\n
(inclusive). Defaults tofalse
. -
trim_tag_left
is similiar totrim_tag_right
, whereas the\n
is exclusive. Defaults tofalse
. See Whitespace Control for details. -
trim_value_right
is used to strip blank characters (including\t
, and\r
) from the right of values ({{ }}
) until\n
(inclusive). Defaults tofalse
. -
trim_value_left
is similiar totrim_value_right
, whereas the\n
is exclusive. Defaults tofalse
. See Whitespace Control for details. -
greedy
is used to specify whethertrim_left
/trim_right
is greedy. When set totrue
, all consecutive blank characters including\n
will be trimed regardless of line breaks. Defaults totrue
.
// register liquid engine
app.engine('liquid', engine.express());
app.set('views', './views'); // specify the views directory
app.set('view engine', 'liquid'); // set to default
There's an Express demo here.
When using with Express.js, partials(includes and layouts) will be looked up in
both Liquid root
and Express views
directories.
Download the dist files and import into your HTML.
And window.Liquid
is what you want. There's also a demo.
<html lang="en">
<head>
<script src="dist/liquid.min.js"></script>
</head>
<body>
<script>
var engine = window.Liquid();
var src = '{{ name | capitalize}}';
var ctx = {
name: 'welcome to liquidjs'
};
engine.parseAndRender(src, ctx)
.then(function(html) {
// html === Welcome to liquidjs
});
</script>
</body>
</html>
Note: In IE and Android UC browser, you need a Promise implementation registered to any-promise.
// file: color.liquid
color: '{{ color }}' shape: '{{ shape }}'
// file: theme.liquid
{% assign shape = 'circle' %}
{% include 'color' %}
{% include 'color' with 'red' %}
{% include 'color', color: 'yellow', shape: 'square' %}
The output will be:
color: '' shape: 'circle'
color: 'red' shape: 'circle'
color: 'yellow' shape: 'square'
// file: default-layout.liquid
Header
{% block content %}My default content{% endblock %}
Footer
// file: page.liquid
{% layout "default-layout" %}
{% block content %}My page content{% endblock %}
The output of page.liquid
:
Header
My page content
Footer
- It's possible to define multiple blocks.
- block name is optional when there's only one block.
// Usage: {{ name | uppper }}
engine.registerFilter('upper', function(v){
return v.toUpperCase();
});
See existing filter implementations: https://github.com/harttle/liquidjs/blob/master/filters.js
// Usage: {% upper name%}
engine.registerTag('upper', {
parse: function(tagToken, remainTokens) {
this.str = tagToken.args; // name
},
render: function(scope, hash) {
var str = Liquid.evalValue(this.str, scope); // 'alice'
return Promise.resolve(str.toUpperCase()); // 'Alice'
}
});
See existing tag implementations: https://github.com/harttle/liquidjs/blob/master/tags/
- Write a test to define the feature you want.
- File an issue, or optionally:
- Get your test pass and make a pull request.