Skip to content

0.6.0

Compare
Choose a tag to compare
@tbouffard tbouffard released this 22 Dec 07:43

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

npm package: 0.6.0
Issues: milestone 0.6.0
See also the Changelog file.

Breaking Changes
Codecs supplied by maxGraph are no longer registered by default. They MUST be registered before performing an encode or decode.
You can use one of the following functions to register codecs:

  • registerAllCodecs
  • registerCoreCodecs
  • registerEditorCodecs

To serialize the maxGraph model, you can use the ModelXmlSerializer class, which registers codecs under the hood.

Highlights

Codecs are no longer registered by default, which reduces side effects and coupling.
It also greatly improves tree-shaking ✨.
For example, in the ts-example application included in this repository which doesn't use the "codec" feature, the size of the minified maxGraph chunk goes from 568.58 kB with version 0.5.0 to 468.01 kB with version 0.6.0 (including new features), which corresponds to a size reduction of 17.7%!

For more details, see #289.

What's Changed

🎉 New Features

  • feat: add ModelXmlSerializer to import/export the model using XML by @tbouffard in #290
  • feat: restore remaining non-"Editor" examples to Storybook by @mcyph in #150

🐛 Bug Fixes

📝 Documentation

  • docs: improve JSDoc of codec classes by @tbouffard in #287
  • docs(release): improve the "examples repository update" paragraph by @tbouffard in #285
  • docs: improve the getting started documentation by @tbouffard in #292

⚙️ Refactor

  • refactor!: move codecs to dedicated files and reduce side effects by @tbouffard in #289

🛠 Chore

New Contributors

Full Changelog: v0.5.0...v0.6.0