Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.01 KB

README.md

File metadata and controls

45 lines (27 loc) · 2.01 KB

Metal.js

Build Status Dependencies Status DevDependencies Status

Metal.js is a JavaScript library for building UI components in a solid, flexible way.

Even though it's powerful, Metal.js is very small, being only around 9kb after compressed with gzip. It's also really well tested, currently with 99% coverage of unit tests, besides having great performance.

Install

Install via npm, or download as a zip:

npm install metal

Usage

With the code already available, you can use Metal.js by just importing the desired module on your js file and calling what you wish on it. For example:

import core from './node_modules/metal/src/core';

// You can now call any function from Metal.js's core module.
core.isString('Hello World');

Note that Metal.js is written in ES6 (a.k.a ECMAScript 2015), so you can also use ES6 on your code like we did on the example. Since ES6 isn't fully implemented on browsers yet though, either a polyfill or a build process is necessary before using Metal.js on a website.

Tools

Metal.js comes together with a set of gulp tasks designed to help develop with it. To learn more about them and use them, take a look at gulp-metal.

Browser Support

Sauce Test Status

License

BSD License © Liferay, Inc.