konva README

The project's README from github.com/konvajs/konva. As one markdown file: README.md.

Konva logo

Konva

Build interactive graphics, editors, and diagrams for the web.

npm downloads npm version Financial Contributors on Open Collective Build Status Build Status CDNJS version

Konva is an open-source 2D canvas framework for interactive graphics. Its scene graph gives each shape its own events, drag behavior, transforms, animation, cache, and export controls.

Use Konva for design editors, whiteboards, diagrams, annotations, maps, and other visual tools. Konva is MIT licensed and does not require a license key.

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

A Konva Transformer around a selected image

Framework integrations

Framework Package Documentation
React react-konva React guide
Vue vue-konva Vue guide
Svelte svelte-konva Svelte guide
Angular ng2-konva Angular guide

Quick Look

import Konva from 'konva';

const container = document.createElement('div');
document.body.appendChild(container);

const stage = new Konva.Stage({ container, width: 600, height: 400 });
const layer = new Konva.Layer();
const box = new Konva.Rect({
  x: 50, y: 50, width: 120, height: 80,
  fill: '#00a8e8', draggable: true,
});

layer.add(box);
stage.add(layer);

Building a full design editor? Polotno is a commercial design editor SDK built on Konva by the Konva maintainers. It ships templates, text editing, and export, so you integrate an editor instead of building one: npm install polotno.

Browsers support

Konva works in modern mobile and desktop browsers that support ES2018.

Debugging

The Chrome inspector simply shows the canvas element. To see the Konva objects and their details, install the konva-dev extension at https://github.com/konvajs/konva-devtool.

Loading and installing Konva

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

Load Konva via classical <script> tag from CDN:

<script src="https://unpkg.com/konva@10/konva.min.js"></script>

Install with npm:

npm install 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:

{
  "compilerOptions": {
    "lib": [
        "es6",
        "dom"
    ]
  }
}

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

In order to run konva in nodejs environment you also need to install canvas or skia-canvas package manually for rendering backend.

# node-canvas backend
npm install konva canvas
# skia-canvas backend
npm install konva skia-canvas

Then you can use the same Konva API and all Konva demos will work just fine. You just don't need to use container attribute in your stage.

import Konva from 'konva';
import 'konva/canvas-backend'; // or import 'konva/skia-backend';

const stage = new Konva.Stage({
  width: 500,
  height: 500,
});
// then all regular Konva code will work

Backers

Konva is maintained by the team behind Polotno, a commercial design editor SDK built on Konva, which sponsors ongoing development.

https://simpleshow.com https://www.notably.ai/

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.

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 (npm run 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]

konva (konvajs/konva)

diagram
Searching Database…

14.9K ·GitHub
Konva
What is this?Konva.js is an open-source 2D canvas framework for the web, used to build interactive graphics: design editors, whiteboards, diagrams, annotations and maps.
Is it a finished editor I can just deploy, or a framework I code against?A framework you code against. It keeps a scene graph where every shape carries its own events, drag behavior, transforms, animation, cache and export controls; the app around it is yours to build.
How do I add it to a project?Install from npm with 'npm install konva' and import it: import Konva from 'konva'. UMD loading is supported, and the framework itself is written in TypeScript.
Which frontend frameworks does it integrate with?Official wrappers exist for React (react-konva), Vue (vue-konva), Svelte (svelte-konva) and Angular (ng2-konva), each with its own guide.
Will it run in every browser?Only modern mobile and desktop browsers: Konva targets browsers with ES2018 support, so legacy browsers are not covered.
Does it live only in the browser, or can I run it server-side?Browser-first, but it also runs in Node.js: install a canvas backend like node-canvas ('npm install konva canvas') or skia-canvas, then import 'konva/canvas-backend' or 'konva/skia-backend'.
What do people actually build with Konva?Design editors, whiteboards, diagrams, annotations and maps. The README points to demos like a canvas editor, free drawing, image crop and a window frame designer, and Polotno, a commercial design editor SDK, is built on it.
Is there a lighter build if I only need a few shapes?Yes. Import 'konva/lib/Core' for Stage, Layer, Group and animations with no shapes or filters included, then add exactly what you need, like Rect from 'konva/lib/shapes/Rect' or Blur from 'konva/lib/filters/Blur'.
How do I debug what is on the canvas?The Chrome inspector only shows a plain canvas element. Install the konva-dev browser extension to see the Konva objects and their details.
Is it free for commercial use?Yes, MIT licensed with no license key required. Ongoing development is sponsored by the team behind Polotno, a commercial design editor SDK built on Konva.
What are similar projects?shaders, tldraw, loadersz-core, open-pencil-cloud, tiptap, particles.js, rough, canvas-ui
Which topics is it in?html5-canvas, whiteboard, 2d, diagram, drag-and-drop, html5, svelte, angular, interactive, canvas, editor, graphics
Creator
konvajs
Size
23.3 MB
Stars
14.9K
Updated
CommitOct 15Release10.9.0Oct 15
Age
11y
Commits · 90 Days