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)

Searching Database…

14.9K ·GitHub
Konva
Что это такое?Konva.js — это open-source-фреймворк для работы с 2D-канвасом в вебе, который используют для создания интерактивной графики: графических редакторов, онлайн-досок, диаграмм, аннотаций и карт.
Это готовый редактор, который можно просто развернуть, или фреймворк, под который нужно писать код?Это фреймворк, под который вы пишете код сами. Он хранит граф сцены, где у каждой фигуры есть свои события, перетаскивание, трансформации, анимация, кэширование и средства экспорта; а приложение вокруг него вы строите сами.
Как добавить его в проект?Установите пакет из npm командой 'npm install konva' и импортируйте его: import Konva from 'konva'. Поддерживается подключение через UMD, а сам фреймворк написан на TypeScript.
С какими фронтенд-фреймворками он интегрируется?Есть официальные обёртки для React (react-konva), Vue (vue-konva), Svelte (svelte-konva) и Angular (ng2-konva), к каждой прилагается свой гайд.
Он будет работать в любом браузере?Только в современных браузерах на компьютере и мобильных: Konva ориентируется на браузеры с поддержкой ES2018, поэтому старые браузеры не поддерживаются.
Он работает только в браузере или его можно запустить на сервере?В первую очередь он для браузера, но работает и в Node.js: установите бэкенд для канваса, например node-canvas ('npm install konva canvas') или skia-canvas, а затем импортируйте 'konva/canvas-backend' или 'konva/skia-backend'.
Что на самом деле делают с помощью Konva?Графические редакторы, онлайн-доски, диаграммы, аннотации и карты. В README есть ссылки на демо вроде канвас-редактора, свободного рисования, обрезки изображений и конструктора оконных рам, а Polotno — коммерческий SDK для редакторов дизайна — построен на Konva.
Есть ли облегчённая сборка, если мне нужны только несколько фигур?Да. Импортируйте 'konva/lib/Core', чтобы получить Stage, Layer, Group и анимации без фигур и фильтров, а затем добавьте ровно то, что нужно, например Rect из 'konva/lib/shapes/Rect' или Blur из 'konva/lib/filters/Blur'.
Как посмотреть, что находится на канвасе, при отладке?Инспектор Chrome показывает только обычный элемент canvas. Установите браузерное расширение konva-dev, чтобы видеть объекты Konva и подробности о них.
Его можно бесплатно использовать в коммерческих проектах?Да, лицензия MIT, ключ лицензии не нужен. Развитие проекта спонсирует команда Polotno — коммерческого SDK для редакторов дизайна, построенного на 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