konva

by konvajs

konvajs / konva

Konva.js is an HTML5 Canvas JavaScript framework that extends the 2d context by enabling canvas inte...

5.5K Stars 534 Forks Last release: over 2 years ago (2.1.3) Other 3.0K Commits 137 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Konva logo

Konva

Financial Contributors on Open Collective Gitter npm version bower version Build Status  Code Climate CDNJS version

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.

Quick Look

Browsers support

Konva works in all modern mobile and desktop browsers. A browser need to be capable to run javascript code from ES2015 spec. For older browsers you may need polyfills for missing functions.

At the current moment

Konva
doesn't work in IE11 directly. To make it work you just need to provide some polyfills such as
Array.prototype.find
,
String.prototype.trimLeft
,
String.prototype.trimRight
,
Array.from
.

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
 tag:


You can also use a CDN: https://unpkg.com/[email protected]^4.0.3/konva.js

2 Install with npm:

npm install konva --save
// The old way (e.g. a CommonJS-style import)
var Konva = require('konva');

// The modern way (e.g. an ES6-style import for webpack, parcel) import Konva from 'konva';

Typescript usage

Add DOM definitions into your

tsconfig.json
and set
esModuleInterop
to
true
:
{
  "compilerOptions": {
    "esModuleInterop": true,
    "lib": [
        "es6",
        "dom"
    ]
  }
}

Then use it:

import Konva from 'konva';

3 Minimal bundle

import Konva from 'konva/lib/Core';
// Now you have a 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: import { Rect } from 'konva/lib/shapes/Rect'; // importing a shape will automatically inject it into Konva object

var rect1 = new Rect(); // or: var shape = new Konva.Rect();

// for filters you can use this: import { Blur } from 'konva/lib/filters/Blur';

4 NodeJS env

We are using node-canvas to create canvas element. Please check installation instructions for it. Then just run

npm install konva-node

Then in you javascript file you will need to use

const Konva = require('konva-node');

See file

konva-node/demo.js
file in this repo as a sample.

Backers

Change log

See CHANGELOG.md.

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.

Testing

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.

Generate documentation

Run

npx 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
).

Contributors

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.