Labyricorn/liquidjs
1
0
Fork 0
mirror of https://github.com/harttle/liquidjs.git synced 2026-09-29 07:05:13 -07:00
Code Issues Packages Projects Releases Wiki Activity

Register tags documentation example updated

Browse Source
This commit is contained in:
ZC
2021-04-17 10:18:39 +08:00
committed by Jun Yang
parent b5a22fa091
commit bad12ea936
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/tutorials/register-filters-tags.md
+7 -4
View File
@@ -6,13 +6,15 @@ title: Register Filters/Tags
```javascript ```javascript
// Usage: {% upper name %} // Usage: {% upper name %}
import { TagToken, Context, Emitter, TopLevelToken } from 'liquidjs'
engine.registerTag('upper', { engine.registerTag('upper', {
parse: function(tagToken, remainTokens) { parse: function(tagToken: TagToken, remainTokens: TopLevelToken[]) {
this.str = tagToken.args; // name this.str = tagToken.args; // name
}, },
render: async function(scope, hash) { render: async function(ctx: Context, emitter: Emitter) {
var str = await this.liquid.evalValue(this.str, scope); // 'alice' var str = await this.liquid.evalValue(this.str, ctx); // 'alice'
return str.toUpperCase() // 'Alice' emitter.write(`<span>${str.toUpperCase()}</span>`) // 'Alice'
} }
}); });
``` ```
@@ -21,6 +23,7 @@ engine.registerTag('upper', {
* `render`: Combine scope data with your parsed tokens into HTML string. * `render`: Combine scope data with your parsed tokens into HTML string.
See existing tag implementations here: <https://github.com/harttle/liquidjs/tree/master/src/builtin/tags> See existing tag implementations here: <https://github.com/harttle/liquidjs/tree/master/src/builtin/tags>
See demo example here: https://github.com/harttle/liquidjs/blob/master/demo/typescript/index.ts
## Register Filters ## Register Filters