Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-bpmn

bpmn-io6.1kMIT0.2.0

Embed BPMN 2.0 diagrams in your React app

bpmn-js, bpmn, react-js, react

readme

react-bpmn

Use bpmn-js to display BPMN 2.0 diagrams in a React application.

Usage

import ReactBpmn from 'react-bpmn';


function App(props) {

  function onShown() {
    console.log('diagram shown');
  }

  function onLoading() {
    console.log('diagram loading');
  }

  function onError(err) {
    console.log('failed to show diagram');
  }

  return (
    <ReactBpmn
      url="/public/diagram.bpmn"
      onShown={ onShown }
      onLoading={ onLoading }
      onError={ onError }
    />
  );
}

Resources

License

MIT

changelog

Changelog

All notable changes to react-bpmn are documented here. We use semantic versioning for releases.

Unreleased

_Note: Yet to be released changes appear here._

0.2.0

  • FEAT: allow open pre-loaded diagram (via diagramXML prop)

0.1.1

  • FIX: correct url update handling

0.1.0

Initial Release.