js-template-artjs api

Posted 2020-09-14 木子旭

一、js api使用

1、template(filename, data)

根据模板名渲染模板。

var html = template(‘tplScriptId‘, {
    value: ‘aui‘
});

在浏览器中，filename 请传入存放模板的元素 id

2、template(filename,source)

编译模板并缓存。

// compile && cache
template(‘tplScriptId‘, ‘hi, <%=value%>.‘);
// use
template(‘tplScriptId‘, {
    value: ‘aui‘
});

3、.compile(source, options)

编译模板并返回一个渲染函数。

var render = template.compile(‘hi, <%=value%>.‘);
var html = render({value: ‘aui‘});

4、.render(source, data, options)

编译并返回渲染结果。

var html = template.render(‘hi, <%=value%>.‘, {value: ‘aui‘});

5、.defaults

模板引擎默认配置。template.defaults

{
    // 模板名
    filename: null,

    // 模板语法规则列表
    rules: [nativeRule, artRule],

    // 是否开启对模板输出语句自动编码功能。为 false 则关闭编码输出功能
    // escape 可以防范 XSS 攻击
    escape: true,

    // 是否开启调试模式。如果为 true: {bail:false, cache:false, minimize:false, compileDebug:true}
    debug: detectNode ? process.env.NODE_ENV !== ‘production‘ : false,

    // bail 如果为 true，编译错误与运行时错误都会抛出异常
    bail: false,

    // 是否开启缓存
    cache: true,

    // 是否开启压缩。它会运行 htmlMinifier，将页面 HTML、CSS、CSS 进行压缩输出
    // 如果模板包含没有闭合的 HTML 标签，请不要打开 minimize，否则可能被 htmlMinifier 修复或过滤
    minimize: true,

    // 是否编译调试版。编译为调试版本可以在运行时进行 DEBUG
    compileDebug: false,

    // 模板路径转换器
    resolveFilename: resolveFilename,

    // HTML 压缩器。仅在 NodeJS 环境下有效
    htmlMinifier: htmlMinifier,

    // 错误事件。仅在 bail 为 false 时生效
    onerror: onerror,

    // 模板文件加载器
    loader: loader,

    // 缓存中心适配器（依赖 filename 字段）
    caches: caches,

    // 模板根目录。如果 filename 字段不是本地路径，则在 root 查找模板
    root: ‘/‘,

    // 默认后缀名。如果没有后缀名，则会自动添加 extname
    extname: ‘.art‘,

    // 导入的模板变量
    imports: {
        $each: each,
        $escape: escape,
        $include: include
    }
};