{"id":25010,"library":"bpmn-js-signavio-compat","title":"bpmn-js-signavio-compat","description":"A Signavio compatibility layer for bpmn-js, enabling interoperability with diagrams exported from Signavio. Current stable version is 1.2.3, with irregular releases as needed. It adds support for Signavio-specific sub-process expand/collapse behavior. Key differentiators: it is the official compatibility module from the bpmn-io team, designed to work with multiple bpmn-js major versions (1.x through 8.x). Requires a transpiler for use. Lightweight plugin that adds a single feature without altering the core bpmn-js library.","status":"active","version":"1.2.3","language":"javascript","source_language":"en","source_url":"https://github.com/bpmn-io/bpmn-js-signavio-compat","tags":["javascript","bpmn-js","bpmn-js-plugin"],"install":[{"cmd":"npm install bpmn-js-signavio-compat","lang":"bash","label":"npm"},{"cmd":"yarn add bpmn-js-signavio-compat","lang":"bash","label":"yarn"},{"cmd":"pnpm add bpmn-js-signavio-compat","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"peer dependency required for integration","package":"bpmn-js","optional":true}],"imports":[{"note":"ESM-only; named default export. No named exports available.","wrong":"const signavioCompatModule = require('bpmn-js-signavio-compat');","symbol":"signavioCompatModule","correct":"import signavioCompatModule from 'bpmn-js-signavio-compat';"},{"note":"When using CommonJS via require, the default export is under .default. Importing the module directly will yield an object with default property.","wrong":"var signavioCompatModule = require('bpmn-js-signavio-compat');","symbol":"signavioCompatModule","correct":"var signavioCompatModule = require('bpmn-js-signavio-compat').default;"},{"note":"The module has a default export, not a named export. Named import will result in undefined.","wrong":"import { signavioCompatModule } from 'bpmn-js-signavio-compat';","symbol":"import signavioCompatModule from 'bpmn-js-signavio-compat'","correct":"import signavioCompatModule from 'bpmn-js-signavio-compat';"}],"quickstart":{"code":"import Modeler from 'bpmn-js/lib/Modeler';\nimport signavioCompatModule from 'bpmn-js-signavio-compat';\n\nconst modeler = new Modeler({\n  container: '#container',\n  additionalModules: [\n    signavioCompatModule\n  ]\n});\n\n// Load a Signavio-exported diagram\nfetch('https://example.com/diagram.bpmn')\n  .then(res => res.text())\n  .then(diagramXML => modeler.importXML(diagramXML))\n  .catch(err => console.error(err));","lang":"typescript","description":"Shows how to add the Signavio compatibility module to a bpmn-js Modeler and import a diagram."},"warnings":[{"fix":"Set up Babel or similar to transpile node_modules if not already configured.","message":"Requires a transpiler (e.g., Babel) to use because it relies on ES modules and may use modern syntax.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Check the Signavio compatibility manually for other features; consider contributing or filing issues.","message":"The package only provides a single feature (sub-process expand/collapse) and may not cover all Signavio-specific behaviors.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Use require('bpmn-js-signavio-compat').default or switch to ES import syntax.","message":"Using require() in CommonJS without .default will yield an object with the actual module as default property, leading to errors when passed as additionalModule.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Ensure you are using the correct import: import signavioCompatModule from 'bpmn-js-signavio-compat'; or const signavioCompatModule = require('bpmn-js-signavio-compat').default;","cause":"Missing or incorrect import/require syntax.","error":"Error: No provider for \"bpmn-js-signavio-compat\"!"},{"fix":"Run npm install bpmn-js-signavio-compat or yarn add bpmn-js-signavio-compat.","cause":"Package not installed or missing in node_modules.","error":"Module not found: Can't resolve 'bpmn-js-signavio-compat'"},{"fix":"Do not invoke the module; pass it directly to additionalModules array as an object.","cause":"Using the module incorrectly, e.g., trying to call it as a function instead of passing as an additional module.","error":"TypeError: signavioCompatModule is not a function"},{"fix":"Use a transpiler like Babel to compile your code, or switch to CommonJS with require('.default').","cause":"ES6+ syntax not transpiled; environment does not support ES modules.","error":"Unexpected token 'export'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}