A lightweight and powerful JavaScript MVVM library for building easy web UI.
JavaScript HTML Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
demos
dist
src
test
.gitignore
.jshintrc
.travis.yml
LICENSE
README.md
package.json

README.md

Travis CI Status Code Coverage
Sauce Browser Matrix

sugar

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

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

  • mvvm.js A simple ViewModel library , it can be used independently.
  • sugar.js Component system + mvvm.js , for building flexible web components.

Diagram

HelloWord

mvvm.js

<html>
<body>
	<div id="app">
		<h1>{{ title }}</h1>
	</div>

	<script src="https://tangbc.github.io/sugar/dist/mvvm.js"></script>
	<script>
	var vm = new MVVM({
		view: document.getElementById('app'),
		model: {
			title: 'Hello world!'
		}
	})

	// Model drive View:
	vm.$data.title = 'Change title!';
	</script>
</body>
</html>

More MVVM directives are supported, see all at documentation.

sugar.js

<html>
<body>
	<div id="app">
		<h1>{{ title }}</h1>
	</div>

	<script src="https://tangbc.github.io/sugar/dist/sugar.js"></script>
	<script>
	// define HelloWorld component:
	var HelloWorld = Sugar.Component.extend({
		init: function (config) {
			this.Super('init', config, {
				target: '#app',
				model: {
					title: 'Hello world!'
				}
			});
		},
		// Hook of after view was rendered.
		afterRender: function () {
			// Model drive View:
			this.vm.$data.title = 'Change title!';
		}
	});

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

SubComponent, component nesting and message system see documentaion.

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