necolas / flight-mustache

A Flight component for rendering Mustache templates with mustache.js

flight-mustache

A Flight component for rendering Mustache templates with mustache.js.

Installation

bower install --save flight-mustache

Example

String templates

Instantiate the Mustache component.

var mustacheComponent = require('flight-mustache/lib/mustache_helper');
mustacheComponent.attachTo(document);

Use the with_mustache mixin:

define(function (require) {
  var defineComponent = require('flight/lib/component');
  var withMustache = require('flight-mustache/lib/with_mustache');

  return defineComponent(myComponent, withMustache);

  function myComponent() {
    this.after('initialize', function () {
      var helloWorld = this.renderTemplate({
        template: 'Hello, {{name}}!',
        renderParams: {
          name: 'World'
        }
      });
    });
  }
});

Pre-compiled templates

You can pass a hash of compiled templates as an option to the component.

define(function (require) {
  var precompiledTemplates = require('templates/compiled');
  var mustacheComponent = require('flight-mustache/lib/mustache_helper');

  mustacheComponent.attachTo(document, {
    precompiledTemplates: precompiledTemplates
  });
});

define(function (require) {
  var defineComponent = require('flight/component');
  var withMustache = require('flight-mustache/lib/with_mustache');

  return defineComponent(myComponent, withMustache);

  function myComponent() {
    this.after('initialize', function () {
      var helloWorld = this.renderTemplate({
        templateName: 'hello_world',
        renderParams: {
          name: 'World'
        }
      });
    });
  }
});

Development

Development of this component requires Bower, and preferably Karma to be globally installed:

npm install -g bower karma

Then install the Node.js and client-side dependencies by running the following commands in the repo's root directory.

npm install
bower install

To continuously run the tests in Chrome and Firefox during development, just run:

karma start

Contributing to this project

Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing.

• Bug reports
• Feature requests
• Pull requests