draftjs_exporter 6.0.0

Library to convert rich text from Draft.js raw ContentState to HTML

Draft.js exporter

Library to convert rich text from Draft.js raw ContentState to HTML.

Features

This project adheres to Semantic Versioning, and measures performance and code coverage. Code is checked with mypy.

• Extensive configuration of the generated HTML.
• Default, extensible block & inline style maps for common HTML elements.
• Convert line breaks to <br> elements with decorators.
• Define any attribute in the block map – custom class names for elements.
• React-like API to create custom components.
• Automatic conversion of entity data to HTML attributes (int & boolean to string, style object to style string).
• Nested lists (<li> elements go inside <ul> or <ol>, with multiple levels).
• Output inline styles as inline elements (<em>, <strong>, pick and choose, with any attribute).
• Overlapping inline style and entity ranges.
• Static type annotations.

It is developed alongside the Draftail rich text editor, for Wagtail. Check out the online demo, and our introductory blog post.

When to use the exporter

Draft.js is a rich text editor framework for React. Its approach is different from most rich text editors because it does not store data as HTML, but rather in its own representation called ContentState. This exporter is useful when the ContentState to HTML conversion has to be done in a Python ecosystem.

The initial use case was to gain more control over the content managed by rich text editors in a Wagtail/Django site. If you want to read the full story, have a look at our blog post: Rethinking rich text pipelines with Draft.js.

Documentation

The full documentation is available at on the docs website. For LLM-assisted tooling, there is also a concise llms.txt and a complete llms-full.txt.

Contributing

See anything you like in here? Anything missing? We welcome all support, whether on bug reports, feature requests, code, design, reviews, tests, documentation, and more. Please have a look at our contribution guidelines.

Credits

Draftail was created by Springload, and is now maintained by Wagtail contributors. View the full list of contributors. MIT licensed.