shaven

v2.1.0

Published

2 years ago

Shaven is a simple DOM building utility and template engine based on JsonML

Downloads

6,997

0High
0Medium
0Low

adius

template DOM building JsonML

Logo

Shaven

A DOM building utility and Template engine based on JsonML with syntax sugar.

Checkout shaven.ad-si.com for extensive documentation.

Example

shaven(
  [document.body,
    ['h1#logo', 'Static Example'],
    ['p','Some example text'],
    ['ul#list.bullets',
      ['li', 'item1'],
      ['li.active', 'item2'],
      ['li',
        ['a', 'item3', {href: '#'}]
      ]
    ],
    ['em', 'Important', {
      style: {
        color: 'red',
        'font-size': '2em',
      },
    }]
  ]
)

compiles to

<body>
  <h1 id="logo">Static Example</h1>
  <p>Some example text</p>
  <ul id="list" class="bullets">
    <li>item1</li>
    <li class="active">item2</li>
    <li><a href="#">item3</a></li>
  </ul>
  <em style="color:red;font-size:2em">Important</em>
</body>

In order to convert HTML fragments to shaven arrays html2shaven can be used.

Features

Syntax Sugar for ids, classes and variable caching
Support for namespaces. (Lets you build SVGs and other XML based languages)
Callback functions on elements
Returns a Object containing the root element and the elements with an id

Advantages

Leverage the full power of JavaScript in your templates. => No need to learn a new language!
Directly integrable into JavaScript files
Works in front- and backend environment
Templates normally tend to get more complicated with the number of variables as they need to get escaped in some way. With Shaven it's exactly the opposite. As variables are native to Shaven the templates get simpler with an increasing number of variables.
Shaven templates can be easily build with every major programming language and their existing JSON/YAML tools.

Installation

npm install --save shaven

Check out shaven.ad-si.com for a detailed description of how to install shaven in other environments.

Browser Support

Firefox: 20+
Opera: 21+
Chrome: 34+
Safari: 9+ (Does not correctly escape HTML strings in attributes)
IE: ? (Probably 9+. Please submit a pull request if you know more.)
Edge (EdgeHTML): 12+

Earlier Firefox, Opera and Chrome versions have the same bug as Safari. That means even much older versions will just work fine under normal circumstances.

Development

Check if code changes must be made in the server and browser version of shaven.

Build website make
Bump version
1. Change version number in package file (semver)
2. Execute npm run prepublish
3. Commit
4. Tag commit (v<version>)
Publish to npm npm publish
Release new version of website: make deploy

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme