Changelog

All notable changes to diagram-js are documented here. We use semantic versioning for releases.

Unreleased

Note: Yet to be released changes appear here.

14.0.0

FEAT: add to selection through SHIFT (#851)
FEAT: allow to provide custom popup menu empty state (#847)
FIX: remove CTRL + click for adding selections (#850)
FIX: correct type definitions (#843, 175da39)
CHORE: remove broken touch interaction (#796)
DEPS: drop hammerjs dependency (#845)

Breaking Changes

(Broken) touch interaction module removed without immediate replacement (#845)
Some type signatures changed

13.4.0

DEPS: update to object-refs@0.4.0

13.3.0

DEPS: update to path-intersection@3

13.2.0

FEAT: add module export

13.1.0

FEAT: allow non-searchable entries in popup menu (#835)

13.0.0

DEPS: update to didi@10.0.1

12.8.1

FIX: reposition popup menu if it opens above the viewport (#829)

12.8.0

FEAT: remove selection outline from connections (#826)
FEAT: position context pad according to last waypoint for connections (#826)

12.7.3

FIX: correct error when computing outline (#822)

12.7.2

FIX: revert djs-dragging CSS class changes (#821)
FIX: clear context pad hover timeout on close (#823)

12.7.1

FIX: revert selection outline removal for connections (#820)

12.7.0

FEAT: support imageHtml option for popup menu header entries (#819)

12.6.0

FEAT: support custom outline providers (#817)
FEAT: remove selection outline from connections (#817)

12.5.0

FEAT: make spacetool local per default (#811)
FEAT: add complex preview feature (#807)
CHORE: mark connection as dragging when moving bendpoint (#807)

12.4.0

FEAT: add zoom through Cmd + mousewheel on macOS (#806)
FEAT: add/remove space locally through Shift + space tool (#808)

12.3.0

FEAT: don't hide overlays on canvas move by default. The config option canvas.deferUpdate now defaults to false (#798)

12.2.0

FEAT: allow to provide html for popup menu entries icons (#790)

12.1.1

FIX: make bio-dts a dev dependency

12.1.0

FEAT: centralize isConnection, isLabel and isRoot checks (#783)
FIX: do not attach labels (#782)
FIX: include entry id in popupMenu.trigger event (#785)
CHORE: fix JSDoc types (#783)

12.0.2

CHORE: fix various JSDoc comments (#780, #781)

12.0.1

FIX: export types as type (#779)

12.0.0

FEAT: rework and complete type definitions (bpmn-io#775)
FEAT: rework model

Breaking Changes

Model elements must be created through factory functions exposed by the model package.
Certain interface like *Provider types (PopupMenuProvider, PaletteProvider) are actual interfaces now

11.13.1

FIX: fix type declaration for ElementFactory (#776)

11.13.0

FEAT: fire popupMenu.trigger, palette.trigger and contextPad.trigger events (#772)

11.12.0

DOCS: add additional parameters to EventCallback type (#759)
CHORE: adjust type declarations to allow augmentation (#757)

11.11.0

FEAT: add translate typings (#756)
FEAT: support select after replacement (#755)

11.10.0

FEAT: add TypeScript declarations for core components (#732)
DEPS: update to didi@9.0.2

11.9.1

FIX: restore undo/redo shortcuts on some international keyboards (#749)

11.9.0

FEAT: allow popup menu entries to be initially hidden (#748)
FIX: filter popup menu entries eagerly to prevent flickering (#748)
FIX: prevent Escape from triggering closing twice (#748)

11.8.0

FEAT: make outline more prominent (#747)
FEAT: add ability to render connections with rounded corners (#747)

11.7.0

FEAT: allow additional search terms for popup menu entries (#745)
FIX: improve popup menu set off off from background (#743)

11.6.0

FEAT: allow to trigger palette entries by ID (#741)
FIX: make popup menu icons decorational (50eb3d7)
FIX: align elements with coordinates around 0 (#740)

11.5.0

FEAT: allow dragstart from popup menu entries (#731)

11.4.4

DEPS: update to @bpmn-io/diagram-js-ui@0.2.2

11.4.3

FIX: prevent canvas scrolling inside popup menu (#729)

11.4.2

FIX: render popup menu inside djs-container (#728)
FIX: correct popup menu overflow (#727)
FIX: drop popup menu backdrop border (e1327caf)

11.4.1

FIX: gracefully handle context pad trigger errors

11.4.0

FEAT: add Overlays#isShown utility (#719)
FEAT: add ContextPad#isShown utility (#719)
FEAT: allow to trigger context pad entries by ID (#719)
FIX: make context pad triggering fail-safe (#719)

11.3.0

FEAT: fire popupMenu.opened and popupMenu.closed events (#718)
FIX: do not search popup menu entries by id (#720)

11.2.1

FIX: correct popup menu icon to label spacing (da5dac5)

11.2.0

FEAT: consistently truncate popup menu elements (#717)
FIX: account for popup menu entry title meta-data (#717)
FIX: apply popup menu element margins only where needed (#717)
CHORE: improve popup menu theming (#717)

11.1.1

FEAT: keep popup menu class structure aligned with diagram-js@10 (f78a1a57)
FIX: remove popup menu container on close (e1df3edd)
FIX: make actual popup menu keyboard selectable (9fda6b0f)
FIX: apply consistent popup-menu spacing (4d4ab8e1)

11.1.0

FEAT: keyboard handles events on bubble phase instead of capture phase (#708)
FEAT: keyboard ignores events that got their propagation stopped or their default prevented (#708)
FIX: popup menu remains open after clicking on it (#702)
FIX: correctly listen for to cancel dragging (#709)
FIX: ensure arrow keys navigation works consistently in popup menu (#701)
FIX: handle popup menu header selection properly (#711)
CHORE: add djs-popup- prefix to popup menu classes (#703)

11.0.0

FEAT: drop KeyboardEvent#keyCode in favor of code (#681)
FEAT: introduction of .djs-parent class to canvas and popup menu root (#687)
FEAT: new popupMenu UI featuring menu and group titles, search, entry descriptions and documentation urls (#686, #695, #697, #699)
FEAT: provide UI utilities through diagram-js/lib/ui (#692)
DOCS: update popup menu provider example (#678)
DOCS: correct ElementRegistry method signatures (#698)
DEPS: bump utility dependencies

Breaking Changes

HTML structure and CSS classes of the popup menu changed in the context of #687. Ensure alignment with the new structure in your custom implementation.
There is no longer a single root (.djs-container). The global selector for both the canvas and popup menu roots is now .djs-parent.
Keyboard-related features no longer use KeyboardEvent#keyCode. Use a polyfill (e.g. keyboardevent-key-polyfill) if you need to support old browsers.

10.0.0

FIX: consider moving and non-moving attachers when using space tool (#480)
FIX: move external labels with moving shapes/connections (#480)
FIX: allow label behavior for laid-out connections (#480)

Breaking Changes

label behavior for laid-out connection is not disallowed anymore

9.1.0

DEPS: bump utility dependencies

9.0.0

FEAT: use ES2018 syntax (#674)
DEPS: update to didi@9

Breaking Changes

Migrated to ES2018 syntax. Read the blog post with details and a migration guide.

8.9.0

FEAT: expose result of editor action execution (#660)
FEAT: only copy if selected elements (#660)
FIX: restore logging of initialization errors
DEPS: update to didi@8.0.1

8.8.0

FEAT: provide keyboard event testing utilities (#664)

7.9.0

FEAT: provide keyboard event testing utilities (#663)

8.7.1

FIX: correct helper SVG styling (#657)

8.7.0

FEAT: use rules to determine which elements should be aligned and distributed (#656)
FIX: distribute elements regardless their relative size (#656)

8.6.0

FEAT: allow to use groups for popup menu entries (#653)
FEAT: set popup menu name via data-popup to allow custom styling
FIX: fix potentially vulnerable code in popup menu, context pad, and palette
FIX: display popup menu even if cursor position is not passed (#654)

8.5.0

Complete rework of outline + drag handles.

FEAT: clearly distinguish select and hover states (b52f35ac)
FEAT: improve outline and drag handle styles (20c8e7a8, 2e73f74a)
FEAT: improve lasso tool colors (2e1c3572)
FEAT: indicate drag via cursor (358c7b9f)
FEAT: expose connection created via connect (ca1ad0c3)
FEAT: select newly created connection (c9c363c7)
FEAT: snap bendpoints to connection (e49eacea)
FEAT: remove broken highlight on connections (02e94f05)
FIX: remove incoming/outgoing connections on connection.delete (#648)

8.4.0

FEAT: add multi-element context pad (#278)
FEAT: allow adding connections to connections (#641)
CHORE: replace inherits with inherits-browser
CHORE: update to didi@8

8.3.0

FEAT: add hit box type to disable move interaction: no-move

8.2.2

FIX: ensure compliance with strict style-src CSP (#636)
FIX: correct palette separator spacing (#633)

8.2.1

FIX: make context pad robust in line-height != 1 environments (#630)

8.2.0

FEAT: add API to hide and show canvas layers (#628)

8.1.2

FIX: ensure ES5 is used everywhere (#624)

8.1.1

FIX: ensure overlays update on root change (#614)
FIX: do not implicitly create root if roots already exist (#619)
FIX: allow removing active root (#619)

8.1.0

FEAT: allow hooking into tree creation (#605)
FIX: only center around visible elements (#605)

8.0.2

FIX: use know color for snap line (#609)

8.0.1

FIX: touchInteractionModule fires element.dblclick events now with button=1 (52af94)
FIX: add multi-root modeling behavior for overlays (26cfc9)

8.0.0

This version of the toolkit makes the tookit truely multi-root aware and drops all Plane related APIs (introduced previously in v7.4.0).

FEAT: make multi-root aware (#600)
FEAT: introduce Canvas APIs for adding, listing and removing root elements (b789c453)
FEAT: allow to remove gfx from ElementRegistry (06f47454)
FIX: don't rely on external styles to hide root elements ( 99c51fa5)

Breaking Changes

All plane related APIs on Canvas got removed, use the newly introduced (add|set)RootElement APIs to accomplish the same thing.
Canvas#setRootElement does not have single root semantics anymore. As such, it does not blow up if a non-existing root is being passed; rather, it adds that new root and shows it.
Canvas#setRootElement has no override semantics anymore. To replace the current root, set a new root and remove the old one.
Canvas#getRootElement supports two different modes for handling root elements. If no root element has been added before, an implicit root will be added. When root elements have been added before, it can return null if none is active.

7.8.1

FIX: rename CSS utility class for clarity (#593)

7.8.0

FEAT: expose pallete state via css classes to djs-container (#591)
FIX: allow passing IDs for canvas.scrollToElement() (#589)

7.7.0

FEAT: incorporate reduced color palette (#581)

7.6.3

FIX: ensure plane layers are rendered with low priority (#585)

7.6.2

FIX: revert #584 (#586)

7.6.1

FIX: ensure inner viewbox is calculated correctly in planes (#580)
FIX: ensure plane layers are rendered with low priority (#584)

7.6.0

FEAT: allow passing attributes to the renderer (#578)
FIX: ensure planes on different planes are always hidden (#574)
FIX: ensure context pad is always in front (#576)

7.5.0

This reverts fixes introduced in v7.3.1.

FEAT: specify which modified keys are handled (#573)
FIX: correct components being unable to handle keyboard events for themselves

7.4.1

FIX: remove all planes on diagram.clear (#569)

7.4.0

FEAT: support multiple planes for rendering elements (#560)

7.3.1

FIX: only ignore non-modifier keys in keyboard (#564)

7.3.0

FEAT: add Canvas#scrollToElement (#545)
FEAT: ensure auto-placed elements are visible
FIX: fix preview for reversed connection (#546)

7.2.3

FIX: correct intersections not being reported in some cases
DEPS: bump path-intersection dependency

7.2.2

FIX: skip element alignment if less than two elements

7.2.1

FIX: do not fail moving bendpoint over non diagram element

7.2.0

FEAT: expose trigger in commandStack.changed event (9a41cbc9)
FIX: correct attach allowed stroke colors (f9ffb44b)
FIX: correct drop fill colors (8a0ef203)
FIX: allow recursive EventBus#once invocations (2e7c4178)

7.1.0

TEST: simplify markup created by built-in test helpers

7.0.0

FEAT: support soft breaks in labels (e3927166)
FEAT: automatically activate tools with last mouse position when activated via keyboard or editor action (#511)
FEAT: immediately activate handtool on SPACE down (#511)
FEAT: allow components to react to auxiliary mouse events (1063f7c18)
FEAT: move canvas on auxiliary button mouse down (138161d6)
CHORE: make tool manager palette click detection fail-safe (5a1454e9)

Breaking Changes

Auxiliary mouse button events will now be passed as element.* mouse events to components. You must filter your event listeners to prevent reactions to these events (1063f7c18).

6.8.2

CHORE: generalize hover fix (#503)

6.8.1

FIX: correct keyboard zoom in binding on international keyboard layouts (#498)

6.8.0

FEAT: support Backspace key for element removal
FEAT: support SHIFT click for adding elements to selection
FEAT: add ElementRegistry#find method

6.7.1

FIX: touch handling for iOS devices (#492)

6.7.0

FEAT: align colors with Camunda Modeler (#477)

6.6.1

FIX: get connected distance based on weight in auto-place (#464)

6.6.0

FEAT: allow connecting with appended shape as source (d1b1fb8)
FEAT: add auto-place feature (#443)
FEAT: allow to specify connection start and end for preview (7dfa896)
FEAT: accept hints for bendpoint move preview (e2c9409)
FEAT: accept layout hints on reconnect (2c30e10)
FEAT: enable top-down modeling (#453)
FEAT: use keyCode as fallback for keyboard key resolution (#456, #460)

6.5.0

FEAT: on resize, keep attachments and connection docking intact if possible (e73bc8b, ec80894)
FIX: correctly handle waypoints if space tool affects only one of connected shapes (393ac63)
FIX: select connect interaction target on connect (#445)
CHORE: provide context when getting minimum dimensions for space-tool (#444)
CHORE: bump dev dependencies (2eb50e5)

6.4.1

FIX: do not interpret 0 as falsy value
CHORE: bump min-dom version

6.4.0

FEAT: do not execute additional modeling behaviors when making space
FIX: copy hidden and collapsed properties (#441)
FIX: do not select hidden elements after create
FIX: do not add preview for hidden elements
CHORE: rewrite space tool

6.3.0

FEAT: improve connection cropping
FEAT: update incoming and outgoing connections on replace (ba5a5fb0)
FIX: prevent double layout on replace (c0db3b4da)

6.2.2

FIX: show line during make space again

6.2.1

Republish of v6.2.0.

6.2.0

FIX: correct a number of cropping issues
CHORE: bump to path-intersection@2.1

6.1.0

FEAT: add horizontal / vertical resize handles (#117)
FIX: correctly mark elements as changed on {shape|connection}.create undo

6.0.2

FIX: revert a change that would disallow re-attaching a connection to the same source / target (fd6f76f6)

6.0.1

Republish of v6.0.0.

6.0.0

FEAT: allow to remove and update palette, context pad and popup menu entries from extensions (#431)
FEAT: allow multiple popup menu providers (#431)
FEAT: support element connections in reverse order (#427)
FIX: correctly unsubscribe popup menu close handler (46f78ea0e)
FIX: allow event bus event to be passed as single argument to EventBus#fire (9633af767)
FIX: pass hints when moving children on replace (cda3686c)

Breaking Changes

Connecting and re-connecting shapes got reworked via #427:

The rules connection.reconnectStart and connection.reconnectEnd got replaced with connection.reconnect rule
The data passed to and propagated via Connect changed from { source, sourcePosition } to { start, connectionStart }
Modeling#reconnect API is introduced for reconnecting both source and target
Layouter#layoutConnection receives a waypoints hint that needs to be taken into account to preview reverse connections
The commands connection.reconnectStart and connection.reconnectEnd got removed in favor of a connection.reconnect command

5.1.1

FIX: re-select only existing elements when dragging is finished (401412d)
FIX: correctly hide nested children of a collapsed shape (9cb6e9b)

5.1.0

FEAT: hide preview without hover (c52518d1)
FEAT: be able to specify hints when copy pasting (09d13e9b)
FEAT: allow attachment of shapes with labels on creation (a4ea3872)
FEAT: allow detaching multiple shapes (e8b34195)
FIX: integrate rules for keyboard move selection (3a25679d)
FIX: return latest changed elements in <elements.changed> command (fd245921)
FIX: cancel create on <elements.changed> command (6ebd3a57)

5.0.2

Republish of v5.0.1.

5.0.1

FIX: do no allow create if no hover available (679ef351)
FIX: relayout loops if necessary (3a63db0d)
FIX: set create target on hover events (d31bd00b)
CHORE: make it easier to override palette container (f765c81a)

5.0.0

FEAT: add ability to create multiple elements (8d7d1d9c)
FEAT: add createElementsBehavior hint to prevent behavior on creating elements (1ef5b3499)
FEAT: add ability to provide custom hit boxes (#371)

Breaking Changes

Copy and paste as well as create got completely reworked:

Create#start: third argument is context, if you want to specify source do { source: source }
CopyPaste: elements.copied, element.copy, elements.copy, element.paste, elements.paste removed in favor of copyPaste.canCopyElements, copyPaste.copyElement, copyPaste.elementsCopied, copyPaste.pasteElement, copyPaste.pasteElements
To prevent additional behavior on create after paste you should check for the createElementsBehavior=false hint
Modeling#pasteElements removed in favor of Modeling#createElements
MouseTracking removed in favor of Mouse

4.0.3

FIX: compensate for missing element.out event (#391)

4.0.2

FIX: do not show connect feedback on bendpoint moving (#382)
FIX: correct graphics update regression (#385

4.0.1

FIX: prevent unnecessary graphics updates (ff52b052)
FIX: correct inverse space tool preview (94644d72)

4.0.0

FEAT: add grid snapping (#319)
FEAT: add support for frame elements (#321)
FEAT: show connection markers in drag preview (#328)
FEAT: support connection previews (#326)
FEAT: do not move if no delta (c0c2b4f3)
FEAT: do not resize if bounds have not changed (e5cdb15a)
FEAT: snap during resize (#344)
FEAT: activate hand tool on SPACE (e7217b95)
FEAT: allow parallel move on larger connection areas (#350)
FEAT: make hosts sticky for valid attachers (#368)
FEAT: improve dragger text styles (#374)
FEAT: allow custom snap implementations to snap an element top, right, bottom and left
CHORE: add reusable escape util (0e520343)
FIX: prevent HTML injection in search component (#362)

Breaking Changes

When displaying a connection preview, Layouter will receive connection without waypoints, source, target and with only { source, target } hints. Make sure it handles such case (#326).

3.3.1

FIX: prevent HTML injection in search component (#362)

2.6.2

FIX: prevent HTML injection in search component (#362)

3.3.0

FEAT: add basic grid snapping (f987bafe)
FEAT: layout connections on start/end reconnection (f7cc7a8f)
FIX: use reference point when resizing (95bef2f6)

3.2.0

FEAT: trigger layout after connection reconnect (#317)

3.1.3

FIX: bump tiny-svg dependency to workaround MS Edge translate bug (657da2c3)

3.1.2

Reverts changes in v3.1.1, as they were unnecessary.

3.1.1

FIX: use correct reference argument for DOM related insert operations (47ca05ca)

3.1.0

FIX: don't swallow event listeners on EventBus#only (#293)
CHORE: rework EventBus internals, fixing various issues (#308)

3.0.2

FIX: make main export an ES module

3.0.1

FIX: correct IE11 delete key binding (d529a676)

3.0.0

FEAT: make ContextPad accessible and scaling configurable (#282)
FEAT: make PopupMenu accessible and scaling configurable (#284)
FEAT: allow Keyboard listener overrides using priorities (#226)
FEAT: add ability to move selected elements with keyboard arrows (9e62bdd)
FEAT: require Ctrl/Cmd modififer to move canvas via keyboard arrows (571efb9)
FEAT: make KeyboardMove and KeyboardMoveSelection speed configurable
FEAT: speed up moving elements / canvas using keyboard errors if SHIFT modifier is pressed
FEAT: add editorAction.init event to register editor actions (a9089ad)
FEAT: only bind Keyboard shortcuts for existing editor actions (aa308fd)
FEAT: rely on rules during GlobalConnect start (1efb277)
FEAT: expose KeyboardEvent to keyboard listeners instead of (keyCode, event) (94b5e26)
FEAT: automatically resize parent elements when children are expanded or replaced (#287)
CHORE: drop implicit feature dependencies in EditorActions (a9089ad)

Breaking Changes

GlobalConnect#registerProvider got removed without replacement. Implement a connection.start rule to control whether it is allowed to start connection with GlobalConnect (1efb277)
The Keyboard now passes the KeyboardEvent to listeners as the only argument rather than (keyCode, event) (94b5e26)
Removed the listeners property from Keyboard lifecycle events (4d72e38)
Moving the canvas via arrow keys now requires Ctrl/Cmd modifiers to be pressed; without the modifiers selected elements will be moved, if the KeyboardMoveSelection feature is provided (571efb9)
EditorActions does not implicitly pull in feature dependencies anymore, ensure you include all desired features with your editor (a9089ad)

2.6.1

FIX: ignore vertical padding when layouting text with middle alignment

2.6.0

CHORE: normalize drag coordinates to full pixel coordinates (#271)

2.5.1

FIX: circumvent IE 9 viewer bug (e1f3c65c)

2.5.0

FEAT: extend manhattan layout helper to support explicit trbl direction and layout U-turns, if needed (fd4c6028)

2.4.1

FIX: ensure all labels / attachers are moved before triggering connection layout
CHORE: move attachers / labels along with move closure (16882649)

2.4.0

FEAT: add ability to remove multiple events via EventBus#off

2.3.0

FEAT: hide palette toggle in expanded state (a none-feature, technically) (#257)
FIX: take top/bottom padding into account when rendering text (#259)
FIX: don't throw error on out-of-canvas lasso tool release

2.2.0

FEAT: support lineHeight in text render util (#256)

2.1.1

FIX: correct code snippet to ES5

2.1.0

FEAT: add support for multiple labels (#202)
FEAT: allow multiple classes to be passed to popup menu entries

2.0.0

FEAT: refactor popup menu to allow multiple providers and simplify API (b1852e1d)

Breaking Changes

The PopupMenu API got rewritten, cf. b1852e1d

1.5.0

This release accidently introduced backwards incompatible changes. Unpublished; Use v2.0.0 instead.

1.4.0

CHORE: bump object-refs version

1.3.1

FIX: correct side-effects config to not include *.css files

1.3.0

FEAT: emit popup menu life-cycle events
FIX: prevent default click action on dragend, if trapClick: true is specified

1.2.1

FIX: escape ids in CSS selectors

1.2.0

DOCS: migrate example to ES modules

1.1.0

CHORE: update utility toolbelt

1.0.0

CHORE: convert code base to ES modules (e26b034)

Breaking Changes

You must now configure a module transpiler such as Babel or Webpack to handle ES module imports and exports.

0.31.0

FEAT: remove EventBus.Event in favor of EventBus#createEvent API (91899cf6)

Breaking Changes

Use EventBus#createEvent to instantiate events

0.30.0

CHORE: bump tiny-svg version

...

Check git log for earlier history.

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

Unreleased

14.0.0

Breaking Changes

13.4.0

13.3.0

13.2.0

13.1.0

13.0.0

12.8.1

12.8.0

12.7.3

12.7.2

12.7.1

12.7.0

12.6.0

12.5.0

12.4.0

12.3.0

12.2.0

12.1.1

12.1.0

12.0.2

12.0.1

12.0.0

Breaking Changes

11.13.1

11.13.0

11.12.0

11.11.0

11.10.0

11.9.1

11.9.0

11.8.0

11.7.0

11.6.0

11.5.0

11.4.4

11.4.3

11.4.2

11.4.1

11.4.0

11.3.0

11.2.1

11.2.0

11.1.1

11.1.0

11.0.0

Breaking Changes

10.0.0

Breaking Changes

9.1.0

9.0.0

Breaking Changes

8.9.0

8.8.0

7.9.0

8.7.1

8.7.0

8.6.0

8.5.0

8.4.0

8.3.0

8.2.2

8.2.1

8.2.0

8.1.2

8.1.1

8.1.0

8.0.2

8.0.1

8.0.0

Breaking Changes

7.8.1