Code Monkey home page Code Monkey logo

sugar's Introduction

Travis CI Status Code Coverage NPM version
Sauce Browser Matrix

sugar

A lightweight and powerful JavaScript MVVM library for building web UI component.

Simple api and without any dependence. Consists of two independent libraries:

  • sugar.js Component system + MVVM , for building flexible web component.
  • mvvm.js Achived above MVVM , it doesn't rely on sugar, it can be used independently.

Diagram

HelloWorld

<html>
<body>
	<div id="app">
		<h1>{{ title }}</h1>
	</div>
</body>
</html>
// define HelloWorld component:
var HelloWorld = Sugar.Component.extend({
	init: function (config) {
		this.Super('init', config, {
			target: '#app',
			model: {
				title: 'Hello world!'
			}
		});
	}
});

// create component instance:
var app = Sugar.core.create('hello-world', HelloWord);

And then the HTML structure was rendered/parsed to be:

<html>
<body>
	<div class="app">
		<h1>Hello world!</h1>
	</div>
</body>
</html>

Data reactive (Model Drive View):

app.vm.$data.title = 'Change the title!'; // <h1>Change the title!</h1>

More MVVM directives are supported, see all at documentation.

Demos

There are several complete and amusing demos in demos/ folder make you know more about sugar.js, check it out and preview them in the following links:

i. Sometimes Github-page link disconnected by Enforce HTTPS, please use https protocol instead.

ii. Some demos need httpSever (Ajax), so run script npm run server to preview them if in your local.

You can also experience sugar.js online with a RadioComponent at jsfiddle.

Usage

Documentation

Get start and check documentation on Wiki.

Directories

  • build/ Development, production and test configurations.

  • demos/ Several complete examples/demos developed by sugar.js.

  • dist/ Product files of sugar.js and mvvm.js, and their compressed.

  • src/ Source code module files:

    • src/main/20% A simple component system. API & Doc

    • src/mvvm/80% A powerful and easy-using MVVM library. API & Doc

  • test/ Unit test specs writing by karma + jasmine.

Contribution

Welcome any pull request of fixbug or improvement, even only supplement some unit test specs.

  1. Fork and clone repository to your local.

  2. Install NodeJS package devtools: npm install.

  3. Develop and debug: npm run dev (generate sourcemap files in bundle/).

  4. Add and write test spec, (in test/units/specs/) then run uint test:npm run test.

  5. Generate the test coverage report and jshint checking up: npm run build.

ChangeLogs

Check details from releases

License

MIT License

sugar's People

Contributors

tangbc avatar

Stargazers

Richard Nii Lante Lawson avatar

Watchers

Richard Nii Lante Lawson 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.