Skip to content

ChristianGrete/polymer-mustache-template

Repository files navigation

polymer-mustache-template

polymer-mustache-template

Travis CI Task Runner Latest GitHub Tag Bower Component Version Node.js Module Version Downloads via npm per Month

A Mustache template for Polymer web components

polymer-mustache-template provides a Mustache template file that can be used to render Polymer local DOM modules (custom elements) from external HTML, CSS and JavaScript files.

For instance, this template could be used by a task runner to build web components out of different sources.

Getting started

Installation

Install this template as a dependency to your project using npm:

$ npm install --save polymer-mustache-template

Alternatively, it is also available on Bower:

$ bower install --save polymer-mustache-template

Usage

This template can easily be required as a CommonJS module in Node.js:

var polymerMustacheTemplate = require('polymer-mustache-template').default;

Hash Example

The following view data is referenced in the template file:

{
  id: 'example-element',
  imports: {
    additional: [
      '../optional/path/to/an/additional/component.html',
      '../another/optional/path/to/an/additional/component.html'
    ],
    polymer: '../required/path/to/polymer.html'
  },
  markup: '<p>Hello world!</p> <!-- This property is optional -->',
  script: 'Polymer({ is: "example-element" }); // This property is required',
  style: '.optional-css-styles { color: red; }'
}

Policy

This is communist software. It is crafted with heart and soul to the best of the author’s knowledge and belief: Not for profit but to satisfy the concrete needs. Do whatever you want with it (as long as you keep the author’s copyright notice in all copies or substantial portions of it included) for free. Imagine how the world could be if others would produce and distribute their products for the same benefits and ask yourself why they’re actually not.

License

This software is licensed under MIT License.

Copyright © 2016 Christian Grete