Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

postit-js-core

0.5.0 • Public • Published

postit-js

Netlify Status Build Status

Create post-it brainstorming boards - built with diagram-js.

Screencast

Checkout the Demo

Features

  • Create resizable Post-its on the Canvas (squared and circled) via
    • Palette
    • Double Click (latest element type will be respected)
  • Change the color of Post-its
  • Create simple Text Boxes on the Canvas
  • Create grouping frame elements on the Canvas
  • Add external image resources on the Canvas

Installation

Install the package to include it into your web application

$ npm install postit-js-core --save

Usage

To get started, create a postit-js instance and render a post-it board into your web application

import 'postit-js-core/assets/postit-js.css';
import PostItModeler from 'postit-js-core/lib/Modeler';
 
let xml; // my post-it xml 
const modeler = new PostItModeler({
  container: '#canvas',
  keyboard: {
    bindTo: window,
  }
});
 
modeler.importXML(xml, function(err) {
  if (err) {
    return console.error('could not import postit board', err);
  }
 
  console.log('board rendered');
});

For using postit-js inside your web application you'll need a source code bundler, e.g. webpack. Checkout the example for getting inspiration.

Development Setup

Spin up the application for development, all strings attached:

$ npm install
cd  example
$ npm install
$ npm run dev

License

MIT

Contains parts of (bpmn-io) released under the bpmn.io license.

Install

npm i postit-js-core

DownloadsWeekly Downloads

2

Version

0.5.0

License

SEE LICENSE IN LICENSE

Unpacked Size

2.84 MB

Total Files

107

Last publish

Collaborators

  • avatar