Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bpmn-io/dmn-js
View and edit DMN diagrams in the browser.
https://github.com/bpmn-io/dmn-js
dmn hacktoberfest javascript
Last synced: about 2 months ago
JSON representation
View and edit DMN diagrams in the browser.
- Host: GitHub
- URL: https://github.com/bpmn-io/dmn-js
- Owner: bpmn-io
- License: other
- Created: 2015-06-05T08:30:47.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-09T11:59:19.000Z (5 months ago)
- Last Synced: 2024-04-14T11:10:10.498Z (5 months ago)
- Topics: dmn, hacktoberfest, javascript
- Language: JavaScript
- Homepage: https://bpmn.io/toolkit/dmn-js/
- Size: 8.36 MB
- Stars: 280
- Watchers: 24
- Forks: 132
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bpmn-io - dmn-js - DMN DRD, decision table and literal expression renderer/editor (Libraries)
README
> __Starting with `dmn-js@8` the library displays and saves DMN 1.3 diagrams only.__ To open older DMN files, [migrate them](https://github.com/bpmn-io/dmn-migrate) before loading them with `dmn-js`.
# dmn-js - DMN for the web
[](https://github.com/bpmn-io/dmn-js/actions?query=workflow%3ACI)
View and edit DMN 1.3 diagrams in the browser.
## Installation
Use the library [pre-packaged](https://github.com/bpmn-io/dmn-js-examples/tree/main/pre-packaged)
or include it [via npm](https://github.com/bpmn-io/dmn-js-examples/tree/main/bundling)
into your node-style web-application.
## Usage
To get started, create a [dmn-js](https://github.com/bpmn-io/dmn-js) instance
and render [DMN 1.3 diagrams](http://www.omg.org/spec/DMN/About-DMN/) in the browser:
```javascript
const xml; // my DMN 1.3 xml
const viewer = new DmnJS({
container: 'body'
});
try {
const { warnings } = await viewer.importXML(xml);
console.log('rendered');
} catch (err) {
console.log('error rendering', err)
}
```
Checkout our [examples](https://github.com/bpmn-io/dmn-js-examples) for
more supported usage scenarios.
### Dynamic Attach/Detach
You may attach or detach the viewer dynamically to any element on the page, too:
```javascript
const viewer = new DmnJS();
// attach it to some element
viewer.attachTo('#container');
// detach the panel
viewer.detach();
```
## Resources
* [Demo](http://demo.bpmn.io/dmn)
* [Issues](https://github.com/bpmn-io/dmn-js/issues)
* [Examples](https://github.com/bpmn-io/dmn-js-examples)
* [Forum](https://forum.bpmn.io)
* [Changelog](./packages/dmn-js/CHANGELOG.md)
## Building the Project
Perform the following steps to build the library, including running all tests:
```
npm install
npm run all
```
Run tests in individual [packages](./packages):
```
npm run dev -- dmn-js
```
## Related
dmn-js builds on top of a few additional powerful tools:
* [dmn-moddle](https://github.com/bpmn-io/dmn-moddle): Read / write support for DMN 1.3 XML
* [diagram-js](https://github.com/bpmn-io/diagram-js): Diagram rendering and editing toolkit
* [table-js](https://github.com/bpmn-io/table-js): Table rendering and editing toolkit
* [dmn-migrate](https://github.com/bpmn-io/dmn-migrate): Migrate your DMN diagrams to DMN 1.3
## Contributing
Please checkout our [contributing guidelines](./.github/CONTRIBUTING.md) if you plan to
file an issue or pull request.
## Code of Conduct
By participating to this project, please uphold to our [Code of Conduct](https://github.com/bpmn-io/.github/blob/main/.github/CODE_OF_CONDUCT.md).
## License
Use under the terms of the [bpmn.io license](http://bpmn.io/license).