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
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
You can use CDN: https://email@example.com/konva.js
2 Load via AMD (requirejs):
3 CommonJS style with npm:
npm install konva --save
// old wayvar Konva = ;// modern way;// typescript;
4 Minimal bundle
If you are using webpack or browserfy you can use this approach to load only required Konva's parts:
;// 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:;//now Konva.Rect is available to use
We are using node-canvas to create canvas element. Please check installation instructions for it. Then just run
npm install konva-node
const Konva = ;
resources/nodejs-demo.js for example.
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.
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
If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in
Konva uses Mocha for testing.
- If you need run test only one time run
- While developing it is easy to use
gulpdefault 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.
gulp api which will build the documentation files and place them in the
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).