Kiwi.js is a fast TypeScript implementation of the Cassowary constraint solving algorithm, based on the seminal Cassowary paper. Originally created by Chris Colbert, it was redesigned from the ground up to be lightweight, fast and easy to maintain. View the benchmarks to see how it compares to Cassowary.js.
Install using NPM:
npm install kiwi.js
Include kiwi in your html and javascript file:
<head>
<script type="text/javascript" src="node_modules/kiwi.js/lib/kiwi.js"></script>
</head>var kiwi = window.kiwi;Or when using requirejs or a bundler like browserify or webpack, use:
var kiwi = require('kiwi.js');The following example creates a solver which automatically calculates the width:
// Create a solver
var solver = new kiwi.Solver();
// Create edit variables
var left = new kiwi.Variable();
var width = new kiwi.Variable();
solver.addEditVariable(left, kiwi.Strength.strong);
solver.addEditVariable(width, kiwi.Strength.strong);
solver.suggestValue(left, 100);
solver.suggestValue(width, 400);
// Create and add a constraint
var right = new kiwi.Variable();
solver.addConstraint(new kiwi.Constraint(new kiwi.Expression([-1, right], left, width), kiwi.Operator.Eq));
// Solve the constraints
solver.updateVariables();
assert(right, 500);To run the benchmark in the browser, just visit this page.
To run the benchmark locally using nodejs, clone or download this repository and execute the following steps:
npm install
grunt bench
To run the tests in the browser, just visit this page.
To run the tests locally using nodejs, clone or download this repository and execute the following steps:
npm install
grunt
If you like this project and want to support it, show some love and give it a star.