Draft.js Exporter

5.2.0 · active · verified Thu Apr 09

draftjs-exporter is a Python library designed to convert rich text from Draft.js raw ContentState, a JSON representation used by the React-based rich text editor, into HTML. It is actively maintained by Springload, currently at version 5.2.0, and regularly releases updates to support newer Python versions and introduce features or performance improvements.

Warnings

breaking Removed support for older Python versions. v5.0.0+ requires Python 3.6+, v4.0.0+ requires Python 3.5+, v3.0.0+ requires Python 3.4+.
Fix: Upgrade your Python environment to 3.6+ (preferably 3.10+) or pin `draftjs-exporter` to a compatible version.
breaking The default string engine in v4.0.0 removed HTML attributes alphabetical sorting and disabled single/double quotes escaping outside of attributes.
Fix: If your application relied on the exact output format of the string engine prior to v4.0.0, you might need to adjust expectations or consider the `string_compat` engine introduced in v5.0.0 for maximum output stability.
gotcha The `parse_html` method (available via `DOMEngine` implementations) does not sanitize its input. Directly using user-provided HTML with this method can lead to XSS vulnerabilities.
Fix: Always sanitize any HTML passed to `parse_html` from untrusted sources before using it with `draftjs-exporter`. The `html5lib` and `lxml` engines offer better parsing and sanitization capabilities than the default `string` engine, but `parse_html` remains a direct HTML parsing function.
gotcha The default 'string' engine is fast and dependency-free but offers no HTML sanitization. For robust handling of potentially unsafe HTML, especially when dealing with user-generated content or arbitrary HTML, consider using the `html5lib` or `lxml` engines.
Fix: Install `draftjs-exporter[html5lib]` or `draftjs-exporter[lxml]` and set the `engine` configuration property to `DOM.HTML5LIB` or `DOM.LXML` respectively. Note that `lxml` requires system libraries `libxml2` and `libxslt`.
gotcha Version 5.0.0 introduced a new `string_compat` engine. If precise, backward-compatible HTML output is critical, this engine is recommended.
Fix: Set the exporter's `engine` property to `DOM.STRING_COMPAT` in your configuration: `config = {'engine': DOM.STRING_COMPAT}`. This ensures consistent output matching its first release.

Install

pip install draftjs-exporter Basic Install
pip install draftjs-exporter[html5lib] Install with html5lib engine
pip install draftjs-exporter[lxml] Install with lxml engine (requires libxml2/libxslt)

Imports

HTML
```
from draftjs_exporter.html import HTML
```
The main class for configuring and rendering Draft.js ContentState to HTML.
DOM
```
from draftjs_exporter.dom import DOM
```
Used for accessing DOM engine constants (e.g., DOM.HTML5LIB, DOM.LXML, DOM.STRING_COMPAT) and creating elements in custom components.

Quickstart

Initialise the `HTML` exporter with a configuration dictionary (often using `DOM` constants for the engine), then call its `render` method with a Draft.js `ContentState` object. The `ContentState` is a JSON-like dictionary describing the rich text structure.

from draftjs_exporter.dom import DOM
from draftjs_exporter.html import HTML

# Example Draft.js ContentState
content_state = {
    'entityMap': {},
    'blocks': [
        {
            'key': '6mgfh',
            'text': 'Hello, world!',
            'type': 'unstyled',
            'depth': 0,
            'inlineStyleRanges': [],
            'entityRanges': []
        }
    ]
}

# Configuration options (can be customized)
config = {
    # Example: use the string_compat engine for consistent output
    'engine': DOM.STRING_COMPAT
}

# Initialize the exporter
exporter = HTML(config)

# Render the ContentState to HTML
html_output = exporter.render(content_state)
print(html_output)
# Expected output: '<p>Hello, world!</p>'

view raw JSON →