Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 26-Dec-2019 | - | ||||
dist/ | H | 26-Dec-2019 | - | 1,486 | 1,142 | |
CHANGELOG.md | H A D | 24-Dec-2019 | 20.7 KiB | 430 | 270 | |
LICENSE | H A D | 24-Dec-2019 | 1.4 KiB | 23 | 19 | |
README.md | H A D | 24-Dec-2019 | 2.2 KiB | 93 | 58 | |
package.json | H A D | 24-Dec-2019 | 2.5 KiB | 95 | 94 | |
url.txt | H A D | 24-Dec-2019 | 90 | 3 | 2 |
README.md
1# bpmn-js - BPMN 2.0 for the web 2 3[](https://travis-ci.org/bpmn-io/bpmn-js) 4 5View and edit BPMN 2.0 diagrams in the browser. 6 7[](http://demo.bpmn.io/s/start) 8 9 10## Installation 11 12Use the library [pre-packaged](https://github.com/bpmn-io/bpmn-js-examples/tree/master/pre-packaged) 13or include it [via npm](https://github.com/bpmn-io/bpmn-js-examples/tree/master/bundling) 14into your node-style web-application. 15 16## Usage 17 18To get started, create a [bpmn-js](https://github.com/bpmn-io/bpmn-js) instance 19and render [BPMN 2.0 diagrams](https://www.omg.org/spec/BPMN/2.0.2/) in the browser: 20 21```javascript 22var xml; // my BPMN 2.0 xml 23var viewer = new BpmnJS({ 24 container: 'body' 25}); 26 27viewer.importXML(xml, function(err) { 28 29 if (err) { 30 console.log('error rendering', err); 31 } else { 32 console.log('rendered'); 33 } 34}); 35``` 36 37Checkout our [examples](https://github.com/bpmn-io/bpmn-js-examples) for many 38more supported usage scenarios. 39 40 41### Dynamic Attach/Detach 42 43You may attach or detach the viewer dynamically to any element on the page, too: 44 45```javascript 46var viewer = new BpmnJS(); 47 48// attach it to some element 49viewer.attachTo('#container'); 50 51// detach the panel 52viewer.detach(); 53``` 54 55 56## Resources 57 58* [Demo](http://demo.bpmn.io) 59* [Issues](https://github.com/bpmn-io/bpmn-js/issues) 60* [Examples](https://github.com/bpmn-io/bpmn-js-examples) 61* [Forum](https://forum.bpmn.io) 62* [Changelog](./CHANGELOG.md) 63 64 65## Building the Project 66 67Perform the following steps to build the library, including running all tests: 68 69``` 70cd bpmn-js 71npm install 72npm run all 73``` 74 75You may need to perform [additional project setup](./docs/project/SETUP.md) when 76building the latest development snapshot. 77 78Please checkout our [contributing guidelines](./.github/CONTRIBUTING.md) if you plan to 79file an issue or pull request. 80 81 82## Related 83 84bpmn-js builds on top of a few powerful tools: 85 86* [bpmn-moddle](https://github.com/bpmn-io/bpmn-moddle): Read / write support for BPMN 2.0 XML in the browsers 87* [diagram-js](https://github.com/bpmn-io/diagram-js): Diagram rendering and editing toolkit 88 89 90## License 91 92Use under the terms of the [bpmn.io license](http://bpmn.io/license). 93