TrimPath 模板引擎使用指南
TrimPath 是一款輕量級的前端 JavaScript 模板引擎,語法類似 FreeMarker, Velocity,主要用于方便地渲染 json 數據
語法 Syntax
表達式 Expressions
表達式和修飾符(其它模板語言中叫做過濾器 filter)中間用 | 分割且 不能有空格
- ${expr}
- ${expr|modifier}
- ${expr|modifier1:arg1,arg2|modifier2:arg1,arg2|...|modifierN:arg1,arg2}
語句 Statements
控制流 Control Flow
- {if testExpr}
- {elseif testExpr}
- {else}
- {/if}
循環(huán) Loops
- {for varName in listExpr}
- {/for}
- {for varName in listExpr}
- ...循環(huán)主體...
- {forelse}
- ...當 listExpr 是 null 或者 length 為 0 ...
- {/for}
變量聲明 Variable Declarations
變量聲明語句用花括號 {} 括起來,不需要關閉。類似 JavaScript 中的賦值語句
- {var varName}
- {var varName = varInitExpr}
宏聲明 Macro Declarations
- {macro macroName(arg1, arg2, ...argN)}
- ...macro 主體...
- {/macro}
CDATA 部分 CDATA Text Sections
CDATA 部分用來告訴模板引擎不用做任何解析渲染,直接輸出。比如展示一個模板字符串本身
- {cdata}
- ${customer.firstName} ${customer.lastName}
- {/cdata}
In-line JavaScript
eval blocks 用來執(zhí)行 JavaScript 代碼片段
- {eval}
- ...模板渲染的時候執(zhí)行的 JavaScript 代碼...
- {/eval
minify blocks 用來壓縮內容中的換行符,比如壓縮 HTML 屬性
- <div id="commentPanel" style="{minify}
- display:none;
- margin: 1em;
- border: 1px solid #333;
- background: #eee;
- padding: 1em;
- {/minify}">
- ...
- </div>
修飾符 Modifier
修飾符用來處理上一個表達式的結果,并輸出內容。類似于 Linux shell 中的 pipe 命名,可以串聯(lián)
- ${name|capitalize}
- ${name|default:"noname"|capitalize}
內置修飾符
- capitalize 返回大寫內容
- default:valueWhenNull 如果內容為 null,返回 valueWhenNull
- eat 返回空內容,一般用于表達式求值后又不想展示輸出的內容
- escape 轉換 HTML 字符實體,比如: & 轉換成 &
- h 和 escape 效果一樣
自定義修飾符
算定義修飾符可以持載到 contextObject 上的 _MODIFIERS 屬性上
- var Modifiers = { toFixed: function(n, num) { return n.toFixed(num) } }
- var out = '{var nu = 12}${nu|toFixed:2}'.process({ _MODIFIERS: Modifiers });
宏 Macro
macro 一般用來封裝可復用 HTML 模板,類似函數的功能。對于每個模板來說 macro 是私用的。如果想公用 macro,可以保存 macro 引用到 contextObject 上(下次調用 process() 方法的時候再手動掛載上!? )。需要在調用 process() 方法之前給 contextObject 設置一個空的 exported 屬性:contextObject['exported'] = {}這個公用的 macro 設計的有點奇葩,可以參考這個 示例
- {macro link(href, name)}
- <a href="${href}">${name}</a>
- {/macro}
- ${link('http://google.com', 'google')} => <a href="http://google.com">google</a>
- ${link('http://facebook.com', 'facebook')} => <a href="http://facebook.com">facebook</a>
示例
- var data = {
- name: 'iPhone 6 Plus',
- weight: 480,
- ram: '16gb',
- networks: [
- '移動(TD-LTE)',
- '聯(lián)通(TD-LTE)',
- '電信(FDD-LTE)'
- ]
- }
- data._MODIFIERS = {
- toFixed: function(n, num) {
- return n.toFixed(num)
- }
- }
- var template = '\
- 名稱: ${name}<br>\
- 重量:${weight|toFixed:2}<br>\
- 內存:${ram|capitalize}<br>\
- 網絡:\
- {for item in networks}\
- {if item_index!=0}|{/if}\
- ${item}\
- {/for}';
- template.process(data)
上面的代碼輸出:
- 名稱: iPhone 6 Plus<br>
- 重量:480.00<br>
- 內存:16GB<br>
- 網絡:
- 移動(TD-LTE)
- | 聯(lián)通(TD-LTE)
- | 電信(FDD-LTE)
【本文是51CTO專欄作者周琪力的原創(chuàng)稿件,轉載請注明出處】