Skip to content

Latest commit

 

History

History
142 lines (99 loc) · 5.3 KB

README.md

File metadata and controls

142 lines (99 loc) · 5.3 KB

Pikaso

Seamless, Fully-typed and Fully-tested HTML5 Canvas Library

Learn more »

Website · API Documentation · Issues . Discussion



Language Test, Build and Publish npm bundle quality coverage

2

Install

NPM

Pikaso provides both ES module and CommonJS bundles, which is easy to use with the popular bundlers

npm install pikaso --save

Yarn

yarn add pikaso

<script> tag

Pikaso also supports UMD loading

<srcipt src="https://cdn.jsdelivr.net/npm/pikaso@latest/umd/pikaso.min.js" type="text/javascript" />

Getting Started

import Pikaso from 'pikaso'

const editor = new Pikaso({
  container: document.getElementById('<YOUR_DIV_ID>'),
})

React

This is possible to directly import the library or reuse the official hook
https://github.com/pikasojs/pikaso-react-hook

NodeJs

Pikaso comes with support for NodeJs out of the box.
Using Pikaso in a NodeJs environment is similar to using it in a browser.

https://pikaso.app/#/advanced/nodejs

Features

Documentation

Full Documentation

API references

Full API references

Demos

React Setup
Vue 3 Setup
Svelte Setup
All Demos

Pikaso vs. Konva

Konva is a great HTML5 Canvas TypeScript framework that extends the 2d context by enabling canvas interactivity for desktop and mobile applications.

Pikaso is built on top of Konva to provide a couple of advanced features that Konva doesn't support out of the box.

Library
HTML5 Canvas Provides low level APIs to draw graphics
Konva Provides Shapes, Dragging, Styling, Events, Transformation and Filters features to HTML5 canvas
Pikaso Adds a lot of Simplicity and provides Free style and Shape Drawing, Advanced Shapes and Groups, State Management (Undo/Redo/Reset), JSON Import/Export, Text Editing, Cropping, Rotation, Transformation, Event Manager, Snap to Grid, Advanced Transformation and Selection, Flipping, Background Image and Background Overlay management, Filter Management to Konva

Supporters

Stargazers repo roster for @pikasojs/pikaso

License

According to the terms of the MIT license, Pikaso is freely distributable.

FOSSA Status