# dmn-js

**Repository Path**: mirrors_bpmn-io/dmn-js

## Basic Information

- **Project Name**: dmn-js
- **Description**: View and edit DMN diagrams in the browser.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-12-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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

[![CI](https://github.com/bpmn-io/dmn-js/workflows/CI/badge.svg)](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).