Draft.js API improvements in 0.10.0 and 0.11.0

What: The API for managing entities will be moved from the global Entity module into contentState, with a deprecation warning in v0.10.0 and a full breaking change in v0.11.0.

Why:

• currently changing or adding entities won’t trigger a re-render. This is a big pain!
• the use of a non-Immutable storage for entities doesn’t fit well with the rest of the Draft architecture
• moves Entity storage out of global module; this just makes more sense as an API, rather than having it globally available. Other maintainers - feel free to add detail and say this more eloquently.

Will 0.10.0 include breaking changes? Nope! When you update to v0.10.0, you should start seeing warnings in the console when the old Entity module API is used. The new API, using contentState will be supported, and you can migrate to the new API incrementally.

We will put out documentation about how to update all use cases when releasing 0.10.0.

Once you are fully migrated to the new API, you can update to 0.11.0, which will include the fully breaking change and will also include the benefits of the new API.

What’s taking so long???

• Since we are improving the API in a breaking way, we are doing extra testing and preparing documentation to make the 0.10.0 and 0.11.0 releases run smoothly.
• We are a tiny team with other projects, and so thanks for everyone’s patience! We are actively working on catching up, and there are discussions ongoing for how to improve the state of this project. See #835.

[tobiasandersen]

Awesome! Great job @flarnie 🥇

[flarnie]

Just an update - we released 0.10.0, including the deprecation of DraftEntity and the new API for managing DraftEntity records.

Next steps:

• Publish v0.11.0@next for beta testing
• Publish any intermediate bug fixes at v0.10.1
• Internal testing of v0.11.0 on Facebook’s wide range of use cases
• Release v0.11.0 and continue doing regular releases in the future