JSPM

bpmn-js

18.12.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 160700
  • Score
    100M100P100Q170561F
  • License SEE LICENSE IN LICENSE

A bpmn 2.0 toolkit and web modeler

Package Exports

  • bpmn-js
  • bpmn-js/dist/assets/bpmn-font/css/bpmn-codes.css
  • bpmn-js/dist/assets/bpmn-font/css/bpmn-embedded.css
  • bpmn-js/dist/assets/bpmn-font/css/bpmn.css
  • bpmn-js/dist/assets/bpmn-js.css
  • bpmn-js/dist/assets/diagram-js.css
  • bpmn-js/dist/bpmn-modeler.production.min
  • bpmn-js/dist/bpmn-modeler.production.min.js
  • bpmn-js/dist/bpmn-navigated-viewer.development
  • bpmn-js/dist/bpmn-navigated-viewer.development.js
  • bpmn-js/dist/bpmn-navigated-viewer.production.min.js
  • bpmn-js/dist/bpmn-viewer.development.js
  • bpmn-js/dist/bpmn-viewer.production.min
  • bpmn-js/dist/bpmn-viewer.production.min.js
  • bpmn-js/lib/BaseModeler
  • bpmn-js/lib/BaseModeler.js
  • bpmn-js/lib/BaseViewer
  • bpmn-js/lib/BaseViewer.js
  • bpmn-js/lib/Modeler
  • bpmn-js/lib/Modeler.js
  • bpmn-js/lib/NavigatedViewer
  • bpmn-js/lib/NavigatedViewer.js
  • bpmn-js/lib/Viewer
  • bpmn-js/lib/Viewer.js
  • bpmn-js/lib/core
  • bpmn-js/lib/core/index.js
  • bpmn-js/lib/draw
  • bpmn-js/lib/draw/BpmnRenderUtil
  • bpmn-js/lib/draw/BpmnRenderUtil.js
  • bpmn-js/lib/draw/BpmnRenderer
  • bpmn-js/lib/draw/BpmnRenderer.js
  • bpmn-js/lib/draw/TextRenderer
  • bpmn-js/lib/draw/TextRenderer.js
  • bpmn-js/lib/draw/index.js
  • bpmn-js/lib/features/align-elements/AlignElementsContextPadProvider
  • bpmn-js/lib/features/align-elements/AlignElementsContextPadProvider.js
  • bpmn-js/lib/features/auto-place
  • bpmn-js/lib/features/auto-place/index.js
  • bpmn-js/lib/features/auto-resize
  • bpmn-js/lib/features/auto-resize/index.js
  • bpmn-js/lib/features/context-pad
  • bpmn-js/lib/features/context-pad/ContextPadProvider
  • bpmn-js/lib/features/context-pad/ContextPadProvider.js
  • bpmn-js/lib/features/context-pad/index.js
  • bpmn-js/lib/features/copy-paste
  • bpmn-js/lib/features/copy-paste/ModdleCopy
  • bpmn-js/lib/features/copy-paste/ModdleCopy.js
  • bpmn-js/lib/features/copy-paste/index.js
  • bpmn-js/lib/features/di-ordering
  • bpmn-js/lib/features/di-ordering/index.js
  • bpmn-js/lib/features/distribute-elements
  • bpmn-js/lib/features/distribute-elements/index.js
  • bpmn-js/lib/features/drilldown
  • bpmn-js/lib/features/drilldown/index.js
  • bpmn-js/lib/features/editor-actions
  • bpmn-js/lib/features/editor-actions/index.js
  • bpmn-js/lib/features/grid-snapping
  • bpmn-js/lib/features/grid-snapping/index.js
  • bpmn-js/lib/features/interaction-events
  • bpmn-js/lib/features/interaction-events/index.js
  • bpmn-js/lib/features/keyboard
  • bpmn-js/lib/features/keyboard/index.js
  • bpmn-js/lib/features/label-editing
  • bpmn-js/lib/features/label-editing/LabelEditingProvider
  • bpmn-js/lib/features/label-editing/LabelEditingProvider.js
  • bpmn-js/lib/features/label-editing/LabelUtil
  • bpmn-js/lib/features/label-editing/LabelUtil.js
  • bpmn-js/lib/features/label-editing/cmd/UpdateLabelHandler
  • bpmn-js/lib/features/label-editing/cmd/UpdateLabelHandler.js
  • bpmn-js/lib/features/label-editing/index.js
  • bpmn-js/lib/features/modeling
  • bpmn-js/lib/features/modeling-feedback/ModelingFeedback
  • bpmn-js/lib/features/modeling-feedback/ModelingFeedback.js
  • bpmn-js/lib/features/modeling/BpmnFactory
  • bpmn-js/lib/features/modeling/BpmnFactory.js
  • bpmn-js/lib/features/modeling/BpmnLayouter
  • bpmn-js/lib/features/modeling/BpmnLayouter.js
  • bpmn-js/lib/features/modeling/BpmnUpdater
  • bpmn-js/lib/features/modeling/BpmnUpdater.js
  • bpmn-js/lib/features/modeling/ElementFactory
  • bpmn-js/lib/features/modeling/ElementFactory.js
  • bpmn-js/lib/features/modeling/Modeling
  • bpmn-js/lib/features/modeling/Modeling.js
  • bpmn-js/lib/features/modeling/behavior/AdaptiveLabelPositioningBehavior
  • bpmn-js/lib/features/modeling/behavior/AdaptiveLabelPositioningBehavior.js
  • bpmn-js/lib/features/modeling/behavior/AppendBehavior
  • bpmn-js/lib/features/modeling/behavior/AppendBehavior.js
  • bpmn-js/lib/features/modeling/behavior/AssociationBehavior
  • bpmn-js/lib/features/modeling/behavior/AssociationBehavior.js
  • bpmn-js/lib/features/modeling/behavior/AttachEventBehavior
  • bpmn-js/lib/features/modeling/behavior/AttachEventBehavior.js
  • bpmn-js/lib/features/modeling/behavior/BoundaryEventBehavior
  • bpmn-js/lib/features/modeling/behavior/BoundaryEventBehavior.js
  • bpmn-js/lib/features/modeling/behavior/CreateBehavior
  • bpmn-js/lib/features/modeling/behavior/CreateBehavior.js
  • bpmn-js/lib/features/modeling/behavior/CreateDataObjectBehavior
  • bpmn-js/lib/features/modeling/behavior/CreateDataObjectBehavior.js
  • bpmn-js/lib/features/modeling/behavior/CreateParticipantBehavior
  • bpmn-js/lib/features/modeling/behavior/CreateParticipantBehavior.js
  • bpmn-js/lib/features/modeling/behavior/DataInputAssociationBehavior
  • bpmn-js/lib/features/modeling/behavior/DataInputAssociationBehavior.js
  • bpmn-js/lib/features/modeling/behavior/DataStoreBehavior
  • bpmn-js/lib/features/modeling/behavior/DataStoreBehavior.js
  • bpmn-js/lib/features/modeling/behavior/DeleteLaneBehavior
  • bpmn-js/lib/features/modeling/behavior/DeleteLaneBehavior.js
  • bpmn-js/lib/features/modeling/behavior/DetachEventBehavior
  • bpmn-js/lib/features/modeling/behavior/DetachEventBehavior.js
  • bpmn-js/lib/features/modeling/behavior/DropOnFlowBehavior
  • bpmn-js/lib/features/modeling/behavior/DropOnFlowBehavior.js
  • bpmn-js/lib/features/modeling/behavior/EventBasedGatewayBehavior
  • bpmn-js/lib/features/modeling/behavior/EventBasedGatewayBehavior.js
  • bpmn-js/lib/features/modeling/behavior/FixHoverBehavior
  • bpmn-js/lib/features/modeling/behavior/FixHoverBehavior.js
  • bpmn-js/lib/features/modeling/behavior/GroupBehavior
  • bpmn-js/lib/features/modeling/behavior/GroupBehavior.js
  • bpmn-js/lib/features/modeling/behavior/ImportDockingFix
  • bpmn-js/lib/features/modeling/behavior/ImportDockingFix.js
  • bpmn-js/lib/features/modeling/behavior/IsHorizontalFix
  • bpmn-js/lib/features/modeling/behavior/IsHorizontalFix.js
  • bpmn-js/lib/features/modeling/behavior/LabelBehavior
  • bpmn-js/lib/features/modeling/behavior/LabelBehavior.js
  • bpmn-js/lib/features/modeling/behavior/LayoutConnectionBehavior
  • bpmn-js/lib/features/modeling/behavior/LayoutConnectionBehavior.js
  • bpmn-js/lib/features/modeling/behavior/MessageFlowBehavior
  • bpmn-js/lib/features/modeling/behavior/MessageFlowBehavior.js
  • bpmn-js/lib/features/modeling/behavior/RemoveElementBehavior
  • bpmn-js/lib/features/modeling/behavior/RemoveElementBehavior.js
  • bpmn-js/lib/features/modeling/behavior/RemoveEmbeddedLabelBoundsBehavior
  • bpmn-js/lib/features/modeling/behavior/RemoveEmbeddedLabelBoundsBehavior.js
  • bpmn-js/lib/features/modeling/behavior/RemoveParticipantBehavior
  • bpmn-js/lib/features/modeling/behavior/RemoveParticipantBehavior.js
  • bpmn-js/lib/features/modeling/behavior/ReplaceConnectionBehavior
  • bpmn-js/lib/features/modeling/behavior/ReplaceConnectionBehavior.js
  • bpmn-js/lib/features/modeling/behavior/ReplaceElementBehaviour
  • bpmn-js/lib/features/modeling/behavior/ReplaceElementBehaviour.js
  • bpmn-js/lib/features/modeling/behavior/ResizeBehavior
  • bpmn-js/lib/features/modeling/behavior/ResizeBehavior.js
  • bpmn-js/lib/features/modeling/behavior/ResizeLaneBehavior
  • bpmn-js/lib/features/modeling/behavior/ResizeLaneBehavior.js
  • bpmn-js/lib/features/modeling/behavior/RootElementReferenceBehavior
  • bpmn-js/lib/features/modeling/behavior/RootElementReferenceBehavior.js
  • bpmn-js/lib/features/modeling/behavior/SpaceToolBehavior
  • bpmn-js/lib/features/modeling/behavior/SpaceToolBehavior.js
  • bpmn-js/lib/features/modeling/behavior/SubProcessPlaneBehavior
  • bpmn-js/lib/features/modeling/behavior/SubProcessPlaneBehavior.js
  • bpmn-js/lib/features/modeling/behavior/SubProcessStartEventBehavior
  • bpmn-js/lib/features/modeling/behavior/SubProcessStartEventBehavior.js
  • bpmn-js/lib/features/modeling/behavior/ToggleCollapseConnectionBehaviour
  • bpmn-js/lib/features/modeling/behavior/ToggleCollapseConnectionBehaviour.js
  • bpmn-js/lib/features/modeling/behavior/ToggleElementCollapseBehaviour
  • bpmn-js/lib/features/modeling/behavior/ToggleElementCollapseBehaviour.js
  • bpmn-js/lib/features/modeling/behavior/UnclaimIdBehavior
  • bpmn-js/lib/features/modeling/behavior/UnclaimIdBehavior.js
  • bpmn-js/lib/features/modeling/behavior/UnsetDefaultFlowBehavior
  • bpmn-js/lib/features/modeling/behavior/UnsetDefaultFlowBehavior.js
  • bpmn-js/lib/features/modeling/behavior/UpdateFlowNodeRefsBehavior
  • bpmn-js/lib/features/modeling/behavior/UpdateFlowNodeRefsBehavior.js
  • bpmn-js/lib/features/modeling/behavior/util/CategoryUtil
  • bpmn-js/lib/features/modeling/behavior/util/CategoryUtil.js
  • bpmn-js/lib/features/modeling/behavior/util/NonInterruptingUtil
  • bpmn-js/lib/features/modeling/behavior/util/NonInterruptingUtil.js
  • bpmn-js/lib/features/modeling/cmd/AddLaneHandler
  • bpmn-js/lib/features/modeling/cmd/AddLaneHandler.js
  • bpmn-js/lib/features/modeling/cmd/IdClaimHandler
  • bpmn-js/lib/features/modeling/cmd/IdClaimHandler.js
  • bpmn-js/lib/features/modeling/cmd/ResizeLaneHandler
  • bpmn-js/lib/features/modeling/cmd/ResizeLaneHandler.js
  • bpmn-js/lib/features/modeling/cmd/SetColorHandler
  • bpmn-js/lib/features/modeling/cmd/SetColorHandler.js
  • bpmn-js/lib/features/modeling/cmd/SplitLaneHandler
  • bpmn-js/lib/features/modeling/cmd/SplitLaneHandler.js
  • bpmn-js/lib/features/modeling/cmd/UpdateCanvasRootHandler
  • bpmn-js/lib/features/modeling/cmd/UpdateCanvasRootHandler.js
  • bpmn-js/lib/features/modeling/cmd/UpdateFlowNodeRefsHandler
  • bpmn-js/lib/features/modeling/cmd/UpdateFlowNodeRefsHandler.js
  • bpmn-js/lib/features/modeling/cmd/UpdateModdlePropertiesHandler
  • bpmn-js/lib/features/modeling/cmd/UpdateModdlePropertiesHandler.js
  • bpmn-js/lib/features/modeling/cmd/UpdatePropertiesHandler
  • bpmn-js/lib/features/modeling/cmd/UpdatePropertiesHandler.js
  • bpmn-js/lib/features/modeling/index.js
  • bpmn-js/lib/features/modeling/util/LaneUtil
  • bpmn-js/lib/features/modeling/util/LaneUtil.js
  • bpmn-js/lib/features/modeling/util/ModelingUtil
  • bpmn-js/lib/features/modeling/util/ModelingUtil.js
  • bpmn-js/lib/features/ordering
  • bpmn-js/lib/features/ordering/index.js
  • bpmn-js/lib/features/outline
  • bpmn-js/lib/features/outline/OutlineProvider.js
  • bpmn-js/lib/features/outline/index.js
  • bpmn-js/lib/features/palette
  • bpmn-js/lib/features/palette/PaletteProvider
  • bpmn-js/lib/features/palette/PaletteProvider.js
  • bpmn-js/lib/features/palette/index.js
  • bpmn-js/lib/features/popup-menu
  • bpmn-js/lib/features/popup-menu/ReplaceMenuProvider
  • bpmn-js/lib/features/popup-menu/ReplaceMenuProvider.js
  • bpmn-js/lib/features/popup-menu/index.js
  • bpmn-js/lib/features/popup-menu/util/Icons
  • bpmn-js/lib/features/popup-menu/util/Icons.js
  • bpmn-js/lib/features/popup-menu/util/TypeUtil
  • bpmn-js/lib/features/popup-menu/util/TypeUtil.js
  • bpmn-js/lib/features/replace
  • bpmn-js/lib/features/replace-preview
  • bpmn-js/lib/features/replace-preview/index.js
  • bpmn-js/lib/features/replace/ReplaceOptions
  • bpmn-js/lib/features/replace/ReplaceOptions.js
  • bpmn-js/lib/features/replace/index.js
  • bpmn-js/lib/features/rules
  • bpmn-js/lib/features/rules/BpmnRules
  • bpmn-js/lib/features/rules/BpmnRules.js
  • bpmn-js/lib/features/rules/index.js
  • bpmn-js/lib/features/search
  • bpmn-js/lib/features/search/index.js
  • bpmn-js/lib/features/snapping
  • bpmn-js/lib/features/snapping/BpmnSnappingUtil
  • bpmn-js/lib/features/snapping/BpmnSnappingUtil.js
  • bpmn-js/lib/features/snapping/index.js
  • bpmn-js/lib/import/BpmnTreeWalker
  • bpmn-js/lib/import/BpmnTreeWalker.js
  • bpmn-js/lib/import/Util
  • bpmn-js/lib/import/Util.js
  • bpmn-js/lib/index.js
  • bpmn-js/lib/util/CompatibilityUtil
  • bpmn-js/lib/util/CompatibilityUtil.js
  • bpmn-js/lib/util/DiUtil
  • bpmn-js/lib/util/DiUtil.js
  • bpmn-js/lib/util/DrilldownUtil
  • bpmn-js/lib/util/DrilldownUtil.js
  • bpmn-js/lib/util/LabelUtil
  • bpmn-js/lib/util/LabelUtil.js
  • bpmn-js/lib/util/ModelUtil
  • bpmn-js/lib/util/ModelUtil.js
  • bpmn-js/lib/util/PoweredByUtil
  • bpmn-js/lib/util/PoweredByUtil.js
  • bpmn-js/test/helper
  • bpmn-js/test/helper/index.js
  • bpmn-js/test/util/MockEvents
  • bpmn-js/test/util/MockEvents.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bpmn-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

bpmn-js - BPMN 2.0 for the web

Build Status

View and edit BPMN 2.0 diagrams in the browser.

bpmn-js screencast

Installation

Use the library pre-packaged or include it via npm into your node-style web-application.

Usage

To get started, create a bpmn-js instance and render BPMN 2.0 diagrams in the browser:

const xml = '...'; // my BPMN 2.0 xml
const viewer = new BpmnJS({
  container: 'body'
});

try {
  const { warnings } = await viewer.importXML(xml);

  console.log('rendered');
} catch (err) {
  console.log('error rendering', err);
}

Checkout our examples for many more supported usage scenarios.

Resources

Build and Run

Prepare the project by installing all dependencies:

npm install

Then, depending on your use-case you may run any of the following commands:

# build the library and run all tests
npm run all

# spin up a single local modeler instance
npm start

# run the full development setup
npm run dev

You may need to perform additional project setup when building the latest development snapshot.

bpmn-js builds on top of a few powerful tools:

  • bpmn-moddle: Read / write support for BPMN 2.0 XML in the browsers
  • diagram-js: Diagram rendering and editing toolkit

It is an extensible toolkit, complemented by many additional utilities.

License

Use under the terms of the bpmn.io license.