konva3.2.6 • Public • Published
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://firstname.lastname@example.org/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
;// now you have Konva object with Stage, Layer, FastLayer, Group, Shape and some additional utils function.// Also core currently already have support for drag&drop and animations.// BUT there are no shapes (rect, circle, etc), no filters.// but you can simply add anything you need:;// importing a shape will automatically inject it into Konva objectvar rect1 = ;// or:var shape = ;// for filters you can use this:;
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.
Building the Konva Framework
To make a full build run
npm run build. The command will compile all typescript files, combine then into one bundle and run minifier.
Konva uses Mocha for testing.
- If you need run test only one time run
npm run test.
- While developing it is easy to use
npm start. Just run it and go to http://localhost:8080/test/runner.html. The watcher will rebuild the bundle on any change.
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.
npx 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).