(Legacy) Render Rich Text Content

Overview

One of the commonly used field types in our Headless CMS is a rich text field. This field uses https://editorjs.io/ with several additional Webiny plugins. The output data structure of editorjs is an array of objects.

You can render this data as you want by traversing the array and implementing renderers for each block type, but more often than not, you just want to use a predefined React component and move on.

Rendering Rich Text Content

To render rich text content created with editorjs in your React app, Webiny provides a package @webiny/react-rich-text-renderer with a React component to do just that.

Installation

In your React app, install the following dependency:

Or if you prefer yarn:

Default Rendering

Fetch your data from Headless CMS, then pass it to the component like this:

Adding Custom Renderers

You can override the default renderers or add new renderers for your custom block types like this:

Styling the Output

Styles for default renderers are included in the package and you can import them into your app like this:

If you don’t want to use the default styles, skip this import and implement your own styling.

HTML Sanitization

In order to minimize the possibility of cross-site scripting (XSS) attacks, the HTML that’s returned by the rich text editor is sanitized, which is done with the help of the sanitize-html library.

Sanitization Configuration

Use configureSanitization function to set your global sanitization preference. To provide sanitize configuration to specific component, use sanitizationConfig prop.

Please check sanitize-html configuration options on their GitHub page.