This document maintains a list of changes to the slate-html-serializer package with each new version. Until 1.0.0 is released, breaking changes will be added as minor version bumps, and smaller changes won't be accounted for since the library is moving quickly.
- Returning
nullnow ignores the node. Previously it would be treated the same asundefined, which will move on to the next rule in the stack. Now it ignores the node and moves onto the next node instead.
-
The
kindproperty of Slate objects has been renamed toobject. This is to reduce the confusion over the difference between "kind" and "type" which are practically synonyms. The "object" name was chosen to match the Stripe API, since it seems like a sensible choice and reads much more nicely when looking through JSON. -
Serializing with
parse5is no longer possible. The codebase previously made concessions to allow this, but it was never a good idea becauseparse5does not match theDOMParserbehavior exactly. Instead, you should usejsdomto get a matching behavior, otherwise your serialization rules need to account for two slightly different syntax trees.
- Remove all previously deprecated code paths. This helps to reduce some of the complexity in Slate by not having to handle these code paths anymore. And it helps to reduce file size. When upgrading, it's highly recommended that you upgrade to the previous version first and ensure there are no deprecation warnings being logged, then upgrade to this version.
- Updated to work with
[email protected]. This is required becauseslate-html-serializerneeds access to the newValuemodel.
- Updated work with
[email protected]. The new version of Slate renames the oldRangemodel toLeaf, and the oldSelectionmodel toRange.
🎉