![\"Konva](\"https://raw.githubusercontent.com/konvajs/konvajs.github.io/master/apple-touch-icon-180x180.png\"){kind=icon}
![\"Konva](\"https://konvajs.org/android-chrome-192x192.png\")
\n ![\"Konva](\"https://konvajs.org/img/icon.png\"){kind=icon}
\n
Build interactive graphics, editors, and diagrams for the web.
\n\n[](https://www.npmjs.com/package/konva)\n[](https://badge.fury.io/js/konva)\n[](https://opencollective.com/konva)\n[](https://github.com/konvajs/konva/actions/workflows/test-browser.yml)\n[](https://github.com/konvajs/konva/actions/workflows/test-node.yml)\n[](https://cdnjs.com/libraries/konva)\n\nKonva 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.\n\nUse Konva for design editors, whiteboards, diagrams, annotations, maps, and other visual tools. Konva is MIT licensed and does not require a license key.\n\nThis repository began as a GitHub fork of [ericdrowell/KineticJS](https://github.com/ericdrowell/KineticJS).\n\n- **Visit:** The [Home Page](https://konvajs.org/) and follow on [Twitter](https://twitter.com/lavrton)\n- **Discover:** [Tutorials](https://konvajs.org/docs/index.html), [API Documentation](https://konvajs.org/api/Konva.html)\n- **Try it:** [Canvas Editor](https://konvajs.org/docs/sandbox/Canvas_Editor.html), [Free Drawing](https://konvajs.org/docs/sandbox/Free_Drawing.html), [Image Crop](https://konvajs.org/docs/sandbox/Canvas_Crop_Image.html), [Window Frame Designer](https://konvajs.org/docs/sandbox/Window_Frame_Designer.html), and [more demos](https://konvajs.org/docs/sandbox.html)\n- **Used by:** [Polotno](https://polotno.com/?utm_source=konvajs) (design editor SDK) and many others — see the full showcase on the [home page](https://konvajs.org/)\n- **Help:** [StackOverflow](https://stackoverflow.com/questions/tagged/konvajs), [Discord Chat](https://discord.gg/8FqZwVT)\n- **Support the project:** [Star Konva on GitHub](https://github.com/konvajs/konva)\n\n[](https://konvajs.org/docs/select_and_transform/Basic_demo.html)\n\n## Framework integrations\n\n| Framework | Package | Documentation |\n| --------- | ------------------------------------------------------------ | ------------------------------------------------------------ |\n| React | [`react-konva`](https://www.npmjs.com/package/react-konva) | [React guide](https://konvajs.org/docs/react/index.html) |\n| Vue | [`vue-konva`](https://www.npmjs.com/package/vue-konva) | [Vue guide](https://konvajs.org/docs/vue/index.html) |\n| Svelte | [`svelte-konva`](https://www.npmjs.com/package/svelte-konva) | [Svelte guide](https://konvajs.org/docs/svelte/index.html) |\n| Angular | [`ng2-konva`](https://www.npmjs.com/package/ng2-konva) | [Angular guide](https://konvajs.org/docs/angular/index.html) |\n\n# Quick Look\n\n```javascript\nimport Konva from 'konva';\n\nconst container = document.createElement('div');\ndocument.body.appendChild(container);\n\nconst stage = new Konva.Stage({ container, width: 600, height: 400 });\nconst layer = new Konva.Layer();\nconst box = new Konva.Rect({\n x: 50,\n y: 50,\n width: 120,\n height: 80,\n fill: '#00a8e8',\n draggable: true,\n});\n\nlayer.add(box);\nstage.add(layer);\n```\n\n> **Building a full design editor?** [Polotno](https://polotno.com/?utm_source=konvajs&utm_medium=readme&utm_content=konva) 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`.\n\n# Browsers support\n\nKonva works in modern mobile and desktop browsers that support ES2018.\n\n# Debugging\n\nThe 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.\n\n# Loading and installing Konva\n\nKonva supports UMD loading. So you can use all possible variants to load the framework into your project:\n\n### Load Konva via classical `\n```\n\n### Install with npm:\n\n```bash\nnpm install konva\n```\n\n```javascript\n// The modern way (e.g. an ES6-style import for webpack, parcel)\nimport Konva from 'konva';\n```\n\n#### Typescript usage\n\nAdd DOM definitions into your `tsconfig.json`:\n\n```\n{\n \"compilerOptions\": {\n \"lib\": [\n \"es6\",\n \"dom\"\n ]\n }\n}\n```\n\n### 3 Minimal bundle\n\n```javascript\nimport Konva from 'konva/lib/Core';\n// Now you have a Konva object with Stage, Layer, FastLayer, Group, Shape and some additional utils function.\n// Also core currently already have support for drag&drop and animations.\n// BUT there are no shapes (rect, circle, etc), no filters.\n\n// but you can simply add anything you need:\nimport { Rect } from 'konva/lib/shapes/Rect';\n// importing a shape will automatically inject it into Konva object\n\nvar rect1 = new Rect();\n// or:\nvar shape = new Konva.Rect();\n\n// for filters you can use this:\nimport { Blur } from 'konva/lib/filters/Blur';\n```\n\n### 4 NodeJS env\n\nIn order to run `konva` in nodejs environment you also need to install `canvas` or `skia-canvas` package manually for rendering backend.\n\n```bash\n# node-canvas backend\nnpm install konva canvas\n# skia-canvas backend\nnpm install konva skia-canvas\n```\n\nUse the same scene graph API for server-side rendering and omit the stage's `container` attribute. DOM events require a browser, and canvas feature support depends on the selected backend.\n\n```js\nimport Konva from 'konva';\nimport 'konva/canvas-backend'; // or import 'konva/skia-backend';\n\nconst stage = new Konva.Stage({\n width: 500,\n height: 500,\n});\n// Add shapes and export the stage with the usual Konva drawing API.\n```\n\n# Backers\n\nKonva is maintained by the team behind [Polotno](https://polotno.com/?utm_source=konvajs&utm_medium=readme&utm_content=konva-backers), a commercial design editor SDK built on Konva, which sponsors ongoing development.\n\n\n\n\n- [myposter GmbH](https://www.myposter.de/)\n- [queue.gg](https://queue.gg/)\n\n# Change log\n\nSee [CHANGELOG.md](https://github.com/konvajs/konva/blob/master/CHANGELOG.md).\n\n## Building the Konva Framework\n\nTo make a full build run `npm run build`. The command will compile all typescript files, combine then into one bundle and run minifier.\n\n## Testing\n\nKonva uses Mocha for testing.\n\n- If you need run test only one time run `npm run test`.\n- While developing it is easy to use `npm start`. Just run it and go to [http://localhost:1234/unit-tests.html](http://localhost:1234/unit-tests.html). The watcher will rebuild the bundle on any change.\n\nKonva is covered with hundreds of tests and well over a thousand assertions.\nFor each feature or bug fix, write a failing test first, implement the behavior, then verify that the test passes (test-driven development).\n\n## Generate documentation\n\nRun `npm run build`, then `npx gulp api` to generate documentation from the current bundle in the `api` folder.\n\n# Pull Requests\n\nI'd be happy to review any pull requests that may better the Konva project,\nin 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`).\n\n## Contributors\n\n### Financial Contributors\n\nBecome a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/konva/contribute)]\n\n#### Individuals\n\n![](\"https://opencollective.com/konva/individuals.svg?width=890\")
\n\n#### Organizations\n\nSupport this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/konva/contribute)]\n\n![](\"https://opencollective.com/konva/organization/0/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/1/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/2/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/3/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/4/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/5/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/6/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/7/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/8/avatar.svg\"){kind=avatar}
\n![](\"https://opencollective.com/konva/organization/9/avatar.svg\"){kind=avatar}
\n","readmeFilename":"README.md","users":{"ywenhao":true,"cestrensem":true}}