ETPL是一个强复用、灵活、高性能的JavaScript模板引擎,适用于浏览器端或Node环境中视图的生成。
JavaScript HTML Other
Clone or download
errorrik Merge pull request #75 from yibuyisheng/master
etpl的expression语法 文档补全
Latest commit ac305f9 Aug 13, 2017
Permalink
Failed to load latest commit information.
doc 用示例的方式展示用法 Feb 8, 2017
src optimize Jun 17, 2016
test add node spec Jun 17, 2016
tool add dist script Jul 2, 2015
.editorconfig add editorconfig Jul 16, 2014
.gitignore add dist to ignore Jul 2, 2015
.npmignore add npm ignore items Jan 4, 2016
.travis.yml remove unuseful before script 4 test Jul 4, 2014
LICENSE add license Nov 26, 2013
README.md add website Jun 20, 2016
main.js node main Jun 17, 2016
package.json bump 3.2.0 Jun 17, 2016

README.md

ETPL (Enterprise Template)

Build Status

ETPL是一个强复用、灵活、高性能的JavaScript模板引擎,适用于浏览器端或Node环境中视图的生成。

WebSite

Download

除了通过github clone外,你可以通过右键另存的方式获得ETpl:

也可以通过CDN引用:

<script src="http://s1.bdstatic.com/r/www/cache/ecom/etpl/3-2-0/etpl.js"></script>

Start

ETpl可以在CommonJS/AMD的模块定义环境中使用,也能直接在页面下通过script标签引用。

浏览器环境

直接通过script标签引用,你可以获得一个全局的etpl变量

<script src="etpl.js"></script>

在AMD环境的模块定义时,你可以通过同步require获得ETpl模块

define(function (require) {
    var etpl = require('etpl');
});

在AMD环境,你也可以通过异步require获得ETpl模块

require([ 'etpl' ], function (etpl) {
});

在AMD环境下,请确保你的require.config配置能够让Loader找到ETpl模块

Node.JS环境

你可以通过npm来安装ETpl

$ npm install etpl

安装完成后,你就可以通过require获得一个ETpl模块,正常地使用它

var etpl = require('etpl');

使用

使用ETPL模块,对模板源代码进行编译,会能得到编译后的function

var render = etpl.compile('Hello ${name}!');

执行这个function,传入数据对象,就能得到模板执行的结果了

var text = render({ name: 'etpl' });

查看更多例子,或者对模板渲染结果有疑虑,就去ETPL的example看看吧。

Documents

通过文档,你可以更详细地了解ETpl的语法格式、使用方法、API等内容。

Related

Compatibility

ETpl3的新语法

我们认为,当前流行的通过block来表达模板继承中的变化,是更好的表达方式。所以在ETpl3中,我们优化了母版的语法,删除了mastercontentplacehodercontent标签,引入了block标签。

对于ETpl2的使用者,我们提供一个etpl2to3工具,能够帮助你平滑地将ETpl2的模板翻译成ETpl3。

get

ETpl2中,为了前向兼容,Engine的get方法可以根据target名称获取模板内容。

ETpl3不再支持该方法,所有的模板都通过render来使用:

  • 直接使用engine实例的render方法
  • 调用renderer function

如果仍需要该功能,说明你正在维护一个遗留系统,并且没有很频繁的升级需求。请继续使用ETpl2。

merge

ETpl的前身是ER框架自带的简易模板引擎,其基本与前身保持兼容。但出于代码体积和使用频度的考虑,ETpl删除了mergeAPI。如果想要该API,请在自己的应用中加入如下代码:

/**
 * 执行模板渲染,并将渲染后的字符串作为innerHTML填充到HTML元素中。
 * 兼容老版本的模板引擎api
 * 
 * @param {HTMLElement} element 渲染字符串填充的HTML元素
 * @param {string} name target名称
 * @param {Object=} data 模板数据
 */
etpl.merge = function ( element, name, data ) {
    if ( element ) {
        element.innerHTML = this.render( name, data );
    }
};