❤
npm
Sign UpSign In

xtpl-deps-fix

3.4.0 • Public • Published

xtpl

nodejs wrapper around xtemplate engine (easier for expressjs and koajs)

xtpl NPM downloads Build Status Coverage Status Dependency Status

docs

syntax

refer: https://github.com/xtemplate/xtemplate

api

methods

config or get xtpl global option:
Object config(option:Object)

option details:

name type default description
encoding String utf-8 xtpl file encoding
XTemplate Object require('xtemplate') xtemplate module value

if options is undefined, then this method will return global config.

render file
void renderFile(path:String, options:Object, callback:function)

parameter details:

name type default description
path String xtpl template file
option Object data to be rendered. the following properties will be used for control.
name type default description
cache Boolean false whether cache xtpl by path
setting['view encoding'] String global encoding encoding for read xtpl files
callback function callback 
npm install xtpl xtemplate --save

var xtpl = require('xtpl');
xtpl.renderFile('./x.xtpl',{
    x:1
},function(error,content){
 
});
express adaptor
xtpl.__express = xtpl.renderFile
clear cache

clear xtemplate cache cached by xtpl file path

void clearCache(path:String);

use for expressjs

var app = require('express')();
app.set('views','./views');
app.set('view engine', 'xtpl');
app.use(function(req, res){
    res.render('test',{data:1});
});

use for koa

var app = require('xtpl/lib/koa')(require('koa')(),{
    views:'./views'
});
app.use(function*(){
    yield this.render('test',{data:1});
});

use for koa2

const koa = require('koa'),
    app = new koa()
const xtpl = require('xtpl/lib/koa2')
    xtpl(app, {
        views:'./views'
    });
app.use(async (ctx, next) => {
    ctx.body = await ctx.render('test',{data:1});
});

Example

├── footer.xtpl
├── header.xtpl
├── index.xtpl
├── layout.xtpl
├── layout1.xtpl
└── sub
    └── header.xtpl

index.xtpl

{{extend ("./layout1")}}

{{#block ("head")}}
<!--index head block-->
<link type="text/css" href="test.css" rev="stylesheet" rel="stylesheet"  />
{{/block}}

{{#block ("body")}}
<!--index body block-->
<h2>{{title}}</h2>
{{/block}}

layout1.xtpl

<!doctype html>
<html>
<head>
<meta name="charset" content="utf-8" />
<title>{{title}}</title>
{{{block ("head")}}}
</head>
<body>
{{{include ("./header")}}}
{{{block ("body")}}}
{{{include ("./footer")}}}
</body>
</html>

render

res.render("index", {title: "xtpl engine!"})

output

<!doctype html>
<html>
<head>
<meta name="charset" content="utf-8" />
<title>xtpl engine!</title>

<!--index head block-->
<link type="text/css" href="test.css" rev="stylesheet" rel="stylesheet"  />

</head>
<body>
<h1>header</h1>
<h2>sub header</h2>

<!--index body block-->
<h2>xtpl engine!</h2>

<h1>footer</h1>

</body>
</html>

changelog

https://github.com/xtemplate/xtpl/milestones

License

xtpl is released under the MIT license.

Readme

Keywords

Package Sidebar

Install

npm i xtpl-deps-fix

Repository

github.com/xtemplate/xtpl

Homepage

github.com/xtemplate/xtpl#readme

Weekly Downloads

0

Version

3.4.0

License

MIT

Unpacked Size

16.4 kB

Total Files

8

Last publish

Collaborators

  • doub
Try on RunKit
Report malware