#Konva

Konva is an HTML5 Canvas JavaScript framework that enables high performance animations, transitions, node nesting, layering, filtering, caching, event handling for desktop and mobile applications, and much more.

You can draw things onto the stage, add event listeners to them, move them, scale them, and rotate them independently from other shapes to support high performance animations, even if your application uses thousands of shapes. Served hot with a side of awesomeness.

This repository began as a GitHub fork of ericdrowell/KineticJS.

• Visit: The Home Page and follow on Twitter
• Discover: Tutorials, API Documentation
• Help: StackOverflow, Chat

Quick Look

<script src="https://cdn.rawgit.com/konvajs/konva/1.2.2/konva.min.js"></script>
<div id="container"></div>
<script>
    var stage = new Konva.Stage({
        container: 'container',
        width: window.innerWidth,
        height: window.innerHeight
    });

    // add canvas element
    var layer = new Konva.Layer();
    stage.add(layer);

    // create shape
    var box = new Konva.Rect({
        x: 50,
        y: 50,
        width: 100,
        height: 50,
        fill: '#00D2FF',
        stroke: 'black',
        strokeWidth: 4,
        draggable: true
    });
    layer.add(box);

    layer.draw();

    // add cursor styling
    box.on('mouseover', function() {
        document.body.style.cursor = 'pointer';
    });
    box.on('mouseout', function() {
        document.body.style.cursor = 'default';
    });
</script>

Loading and installing Konva

Konva supports UMD loading. So you can use all possible variants to load the framework into your project:

###1 Load Konva via classical <script> tag:

<script src="https://cdn.rawgit.com/konvajs/konva/1.2.2/konva.min.js"></script>

You can use CDN: https://cdn.rawgit.com/konvajs/konva/1.2.2/konva.min.js

###2 Load via AMD (requirejs):

define(['./konva'], function(Konva) {
   // your code
});

###3 CommonJS style with npm:

npm install konva --save

// old way
var Konva = require('konva');


// modern way
import Konva from 'konva';

// typescript
import * as Konva from 'konva';

###4 Minimal bundle

If you are using webpack or browserfy you can use this approach to load only required Konva's parts:

import Konva from 'konva/src/Core';
// now you have Konva object with Stage, Layer, FastLayer, Group, Shape and some additional utils function
// so there are no shapes (rect, circle, etc), no filters, no d&d support.


// but you can simply add anything you need:
import 'konva/src/shapes/rect';
//now Konva.Rect is available to use

###5 NodeJS

You have to install some deps manually to use Konva in nodejs env.

We are using node-canvas to create canvas element.

1. Install node-canvas dependencies https://github.com/Automattic/node-canvas
2. npm install canvas --save
3. npm install jsdom --save
4. npm install konva --save

See file resources/nodejs-demo.js for example.

Last tested with node@5.10.1, canvas@1.3.14, jsdom@8.5.0

#Change log

See CHANGELOG.md.

#Dev environment

Before doing all dev stuff make sure you have node installed. After that, run npm install in the main directory to install the node module dependencies.

Run gulp -T to see all build options.

##Building the Konva Framework

To build a development version of the framework, run gulp dev-build. To run a full build, which also produces the minified version run gulp build.

If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in gulpfile.js.

##Testing

Konva uses Mocha for testing.

• If you need run test only one time run gulp test.
• While developing it is easy to use gulp default task with watch. Just run it and go to http://localhost:8080/test/runner.html. After src file change konva-dev.js will be automatically created, so you just need refresh test the page.

Konva is covered with hundreds of tests and well over a thousand assertions. Konva uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test.

##Generate documentation

Run gulp api which will build the documentation files and place them in the api folder.

#Pull Requests I'd be happy to review any pull requests that may better the Konva project, in particular if you have a bug fix, enhancement, or a new shape (see src/shapes for examples). Before doing so, please first make sure that all of the tests pass (gulp lint test).