✨ Announcing maxGraph 0.12.0 🎉

[tbouffard]

⚡ This new version contains enhancements, documentation improvements and bug fixes. ⚡

This release also improves the tree-shaking 🎉, so the size of applications using maxGraph should therefore decrease.

npm package: 0.12.0
Fixed issues: milestone 0.12.0
See also the Changelog file.

Breaking changes

VertexHandler.rotationEnabled has been removed as it was not possible to correctly change its value.
Use VertexHandlerConfig.rotationEnabled to configure the rotation behavior globally or override the VertexHandler.isRotationEnabled method.
For more details, see #480.

Highlights

The code in the @maxgraph/core npm package is now free from side effects.
This change improves the tree-shaking ✨.

Here are a few examples of measured decreases.
Notice that the bundlers used in these examples are not tuned, they are mainly using the default configuration. So, it is probably possible to improve the tree-shaking efficiency in these examples.

Examples in the maxGraph repository

As a reminder:

• ts-example:
  • TypeScript application built with Vite
  • includes custom shapes
  • sizes shown are for the maxGraph chunk only which doesn't include the rest of the application
• js-example:
  • JavaScript application built with webpack
  • includes model codecs
  • bundles the maxGraph common.css file (4.33kB unminified) within the js bundle
  • sizes shown are for the entire application

Example	0.11.0	0.12.0
ts-example (maxGraph chunk)	444.89 kB	444.46 kB
js-example	512.61 kB	458.7 kB

Without this change, the size of the chunk in ts-example would have been 555.24 kB.
For more details, see #484

Examples in the https://github.com/maxGraph/maxgraph-integration-examples repository

Example	0.11.0	0.12.0
lit with vite index.js	466.76 kB	466.42 kB
parcel	627.5 KB	498.3kB
rollup	444.0 kB	443.7 kB
vite	447.32 kB	446.97 kB

Sizes collected from maxGraph/maxgraph-integration-examples#139.

What's Changed

🎉 New Features

• feat: accept Element parameter in ModelXmlSerializer.import by @tbouffard in feat: accept Element parameter in ModelXmlSerializer.import #471
• feat!: ease the configuration to rotate the selected vertex by @tbouffard in feat!: ease the configuration to rotate the selected vertex #480
• feat: declare the package as side effects free by @tbouffard in feat: declare the package as side effects free #484

🐛 Bug Fixes

• fix: restore the GraphCodec implementation by @tbouffard in fix: restore the GraphCodec implementation #434
• fix(type): declare Graph.toggleCellStyles optional parameters by @tbouffard in fix(type): declare Graph.toggleCellStyles optional parameters #475
• fix(story): improve the 'Stencils' story by @tbouffard in fix(story): improve the 'Stencils' story #476
• fix(type): declare Graph.toggleCellStyle optional parameters by @tbouffard in fix(type): declare Graph.toggleCellStyle optional parameters #477
• fix: correctly encode Geometry XML node when maxGraph is minified by @tbouffard in fix: correctly encode Geometry XML node when maxGraph is minified #488

📝 Documentation

• docs: declare JSDoc of SnapMixin in type definition by @tbouffard in docs: declare JSDoc of SnapMixin in type definition #451
• docs: declare JSDoc of SwimlaneMixin in type definition by @tbouffard in docs: declare JSDoc of SwimlaneMixin in type definition #452
• docs: declare JSDoc of EventsMixin in type definition by @tbouffard in docs: declare JSDoc of EventsMixin in type definition #453
• docs: declare JSDoc of FoldingMixin in type definition by @tbouffard in docs: declare JSDoc of FoldingMixin in type definition #454
• docs: declare JSDoc of PageBreaksMixin in type definition by @tbouffard in docs: declare JSDoc of PageBreaksMixin in type definition #455
• docs: declare JSDoc of PortsMixin in type definition by @tbouffard in docs: declare JSDoc of PortsMixin in type definition #456
• docs: declare JSDoc of PanningMixin in type definition by @tbouffard in docs: declare JSDoc of PanningMixin in type definition #457
• docs: declare JSDoc of DragDropMixin in type definition by @tbouffard in docs: declare JSDoc of DragDropMixin in type definition #458
• docs: improve JSDoc of EdgeMixin by @tbouffard in docs: improve JSDoc of EdgeMixin #459
• docs: declare JSDoc of EditingMixin in type definition by @tbouffard in docs: declare JSDoc of EditingMixin in type definition #460
• docs: declare JSDoc of SelectionMixin in type definition by @tbouffard in docs: declare JSDoc of SelectionMixin in type definition #461
• docs: declare JSDoc of OverlaysMixin in type definition by @tbouffard in docs: declare JSDoc of OverlaysMixin in type definition #463
• docs: declare JSDoc of CellsMixin in type definition by @tbouffard in docs: declare JSDoc of CellsMixin in type definition #464
• docs: declare JSDoc of OrderMixin in type definition by @tbouffard in docs: declare JSDoc of OrderMixin in type definition #465
• docs: declare JSDoc of LabelMixin in type definition by @tbouffard in docs: declare JSDoc of LabelMixin in type definition #466
• docs: declare JSDoc of ImageMixin in type definition by @tbouffard in docs: declare JSDoc of ImageMixin in type definition #467
• docs: declare JSDoc of ConnectionMixin in type definition by @tbouffard in docs: declare JSDoc of ConnectionMixin in type definition #468
• docs: declare JSDoc of GroupingMixin in type definition by @tbouffard in docs: declare JSDoc of GroupingMixin in type definition #469
• docs: declare register functions in the "Configuration" category by @tbouffard in docs: declare register functions in the "Configuration" category #472
• docs: improve the BUG issue template by @tbouffard in docs: improve the BUG issue template #483
• docs: improve setup instructions for ts-example by @tbouffard in docs: improve setup instructions for ts-example #487
• docs: improve setup instructions for js-example by @hbmartin in docs: improve setup instructions for js-example #486

⚙️ Refactor

• refactor: apply Graph mixins without using side effects by @tbouffard in refactor: apply Graph mixins without using side effects #470

New Contributors

• @hbmartin made their first contribution in docs: improve setup instructions for js-example #486

Full Changelog: v0.11.0...v0.12.0

---

This discussion was created from the release 0.12.0.