# vue-bpmn

**Repository Path**: mirrors_bpmn-io/vue-bpmn

## Basic Information

- **Project Name**: vue-bpmn
- **Description**: Display BPMN 2.0 diagrams in Vue.js
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

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

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vue-bpmn

[![CI](https://github.com/bpmn-io/vue-bpmn/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/vue-bpmn/actions/workflows/CI.yml)

Use [bpmn-js](https://github.com/bpmn-io/bpmn-js) to display BPMN 2.0 diagrams in a [Vue.js](https://vuejs.org) application.


## Usage

```html
<template>
  <vue-bpmn
    url="/public/diagram.bpmn"
    :options="options"
    v-on:error="handleError"
    v-on:shown="handleShown"
    v-on:loading="handleLoading"
  ></vue-bpmn>
</template>

<script>
  import VueBpmn from 'vue-bpmn';

  export default {
    components: {
      VueBpmn
    },
    data() {
      return {
        options: {
          propertiesPanel: {},
          additionalModules: [],
          moddleExtensions: []
        }
      }
    },
    methods: {
      handleError: function(err) {
        console.error('failed to show diagram', err);
      },
      handleShown: function() {
        console.log('diagram shown');
      },
      handleLoading: function() {
        console.log('diagram loading');
      }
    }
  };
</script>
```

Note that the diagram will be loaded via ajax from the given `url` and thus must be served by your app.


## Resources

* [Issues](https://github.com/bpmn-io/vue-bpmn/issues)
* [Example](./example)


## License

MIT