Giter Club home page Giter Club logo

jangular's Introduction

Jangular

This library works with Jyt to render Angular HTML markup on the server. This is how it works at a high level:

  1. Write your HTML using Jyt.
    • div({ 'class': 'foo' }, span('hello'))
  2. Add Angular markup to your Jyt markup.
    • var markup = div({ 'ng-if': 'someVal', 'class': 'foo' }, span({ 'ng-bind': 'greeting' }, 'hello'))
  3. Pass your markup into Jangular with a model.
    • var html = jangular.render(markup, { someVal: true, greeting: 'Hello, world' })
  4. You now have rendered HTML in a string that you can return to the user or whatever else you want.
    • <div ng-if="someVal" class="foo"><span ng-bind="greeting">Hello, world</span></div>

Installation

From the command line enter:

npm install jangular --save

Then use Jangular anywhere in your node.js code. For example:

var jangular = require('jangular');

// add all the HTML functions to the local scope
jangular.addShortcutsToScope(global);

var markup = div({ 'ng-if': 'someVal', 'class': 'foo' }, span({ 'ng-bind': 'greeting' }, 'hello'));
var html = jangular.render(markup, { someVal: true, greeting: 'Hello, world' });

console.log(html);
// output: <div ng-if="someVal" class="foo"><span ng-bind="greeting">Hello, world</span></div>

API

The following functions are available with Jangular:

  • render(markup, model, strip) - As described above. Strip is a boolean that will remove Angular directives after rendering them.
  • addShortcutsToScope(obj) - This will add all the HTML functions to whatever object is passed in.
  • registerPlugin(name, fn) - This is used to register a Jyt plugin.
  • addDirective(name, fn) - Add a custom directive to Jangular (essentially a callback to the directive's link() function)
  • addFilters(name, arr) - Add filters Jangular will evaluate while rendering

Pancakes

While this library can be used on its own without any issues, it was design to work with Pancakes through the pancakes-angular plugin. Basically, this library is dumb about how it is used. It simple rendering Jyt markup with Angular any registered Angular directives. Pancakes-angular is used to generate a set of custom directives based off the app that is using Pancakes.

jangular's People

Contributors

christianallen avatar jeffwhelpley avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.