Skip to content

Latest commit

 

History

History
112 lines (88 loc) · 2.85 KB

README.md

File metadata and controls

112 lines (88 loc) · 2.85 KB
Raw

gloomy

A simple and semantic substitution template engine for the browser. :[

How-to

Templates

Write your templates by using plain HTML in a <script> element. You must put your variables between a gloomy expression (e.g. :[foo.bar]).

<script id="user-template" type="text/gloomy">
    <li id=":[id]" class="user-box">
        <h2 class="user-box-title">
            <a href=":[website]">:[user.fullname]</a>
        </h2>
        <img src=":[user.pic]" width="80" height="80" alt=":[user.fullname]" class="user-box-avatar">
        <a href="https://twitter.com/:[username]">@:[username]&lt;/a>
    </li>
</script>

Data

Create your model data as JSON objects.

var user = [
    {
        'id': 1,
        'username': 'pazguille',
        'website': 'http://pazguille.me',
        'user':{
            'fullname': 'Guille Paz',
            'pic': 'http://twitter.com/api/users/profile_image/pazguille?size=bigger'
        }
    },
    {
        'id': 2,
        'username': 'frontendrescue',
        'website': 'http://uptodate.frontendrescue.org/',
        'user':{
            'fullname': 'Front-end Rescue',
            'pic': 'http://twitter.com/api/users/profile_image/frontendrescue?size=bigger'
        }
    }
];

Render

You should create a container to insert the result of a template rendered with the data.

<ul id="user-list"></ul>

Then, create a new instance of Gloomy and enjoy!

var template = document.querySelector('#user-template'),
    container = document.querySelector('#user-list'),
    gloomy = new Gloomy(template, container);

gloomy.render(data);

View demo page

API

Gloomy([template], [container], [data])

Create a new instance of Gloomy.

  • template: A given gloomy template.
  • container: A given HTMLElement to insert the result of a template rendered with the data.
  • data: A given model data to render.
var gloomy = new Gloomy(template, container, data);

Gloomy#use(template)

Sets what gloomy template would you to use.

  • template: A given gloomy template.
gloomy.use(template);

Gloomy#into(container)

Sets a container to insert the result of a template rendered with the data.

  • container: A given HTMLElement to insert the result of a template rendered with the data.
gloomy.into(container);

Gloomy#render(data)

Render the template with a given data and inserts the output in a container.

  • data: A given model data to render.
gloomy.render(data);

Maintained by

License

Licensed under the MIT license.

Copyright (c) 2013 @pazguille.