# stencil stencil is a templating engine designed by Andy VanWagoner ([thetalecrafter](http://github.com/thetalecrafter)) to enable templates to run in an environment with asynchronous I/O, such as [node](http://nodejs.org), as well as in the browser. While there have been many other libraries with the same claims, all of the ones currently maintained use the mustache syntax, while this uses asp / erb / php style syntax. ## Features * Async nested templates * Async tag to ensure template is processed sequentially * Use the same template code both server and client side ## Shared templates The motivator for stencil was to share templates between server and client code. The template can be used server side to generate a widget in the initial page load, and then the template can be included on the page to update the widget. The code to generate and update a widget can be the same file. ## Usage - template code Templates are specified using php/asp syntax, with code inside special tags. By default the tags are php-style: ```php ``` There are also suffixes to the opening tag for ouput, include, and async blocks. ```php Important' // This output won't be encoded ?> ``` Members of the data object are put in the scope of the template code: ```html ``` Important note: Unlike regular code tags, async tags cannot not include partial statements. All of the code inside will be wrapped into a function. All of the code following will also be wrapped into a function. This would not work: ```php some output ``` Since compiled it would be similar to: ```javascript (function(next){ if (true) { })(function() { print('some output'); } }); ``` ## Usage - client side ```html ``` ## Usage - server side ```javascript var stencil = require('./stencil'); stencil('/path/to/template', { data:object }, function(data) { /* use the data chunks */ }, function(err, result) { /* all done */ } ); // same variations apply as client side. ``` ## Usage - custom tags ```javascript stencil({ id: id, start: '`', stop: '`', echo: 'print', safe: 'encode', nest: ' include this template:', async: '@' }, data, function(err, result) { // here's my result }); // template code: My pet is `if (hungry) { `hungry` } else { `sleepy` }`. His name is: `print pet.name`. He looks like: ` include this template: 'looks_like', pet `. `@my_async_function(function(result) { print(result); next(); });` the end. ``` ## Usage - synchronous You can fetch templates synchronously, if you need to. The caveat here is that you cannot do anything asynchronous in your template, or you will only get the ouput up until the first asynchronous part. The setting really only makes includes happen synchronously. ```javascript try { var result = stencil({ id:'id', sync_include:true }, data); } catch (err) { /* You broke it. */ } ``` ## License (The MIT License) Copyright (c) 2012 Andy VanWagoner Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

	Stars	Issues	Version	Updated	Created
@angular/core			17.3.9	3 days ago	8 years ago
elm	7,453	330	0.19.1-6	7 months ago	10 years ago
stencil	9	2	0.0.5	11 years ago	12 years ago
stencil-js	9	0	0.8.4	12 years ago	12 years ago
svelte	76,789	848	4.2.17	5 days ago	8 years ago

@angular/core vs elm vs stencil vs stencil-js vs svelte

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past