@webiny/react-rich-text-renderer
TypeScript icon, indicating that this package has built-in type declarations

5.39.6 • Public • Published

@webiny/react-rich-text-renderer

code style: prettier PRs Welcome

A React component to render data coming from Webiny Headless CMS and Webiny Form Builder.

About

Webiny uses https://editorjs.io/ as a go to Rich Text Editor, with some additional plugins. To speed up the rendering of data for developers, we created this component with default renderers for block types that are used in Webiny by default.

Install

npm install --save @webiny/react-rich-text-renderer

Or if you prefer yarn:

yarn add @webiny/react-rich-text-renderer

Usage

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

import {RichTextRenderer} from "@webiny/react-rich-text-renderer";

// Load content from Headless CMS (here we show what your content might look like).
const content = [
    {
        type: "paragraph",
        data: {
            text: "A well written paragraph of text can bring so much joy!",
            textAlign: "left",
            className: ""
        }
    }
];

// Mount the component.
<RichTextRenderer data={content}/>;

Adding custom renderers

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

import {RichTextRenderer, RichTextBlockRenderer} from "@webiny/react-rich-text-renderer";

const customRenderers: Record<string, RichTextBlockRenderer> = {
    // Override the default renderer for "delimiter" block
    delimiter: block => {
        return <div data-type={block.type} className={"my-custom-delimiter"}/>;
    },
    // Add a renderer for "youtube" block.
    youtube: block => {
        return (
            <iframe
                width="560"
                height="315"
                src={block.data.url}
                title={block.data.title}
                frameborder="0"
                allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
                allowfullscreen
            ></iframe>
        );
    }
};

const content = [
    // This block will use the default renderer.
    {
        type: "paragraph",
        data: {
            text: "A well written paragraph of text can bring so much joy!",
            textAlign: "left",
            className: ""
        }
    },
    // This block will use the custom "delimiter" renderer.
    {
        type: "delimiter"
    },
    // This block will use the new "youtube" renderer.
    {
        type: "youtube",
        data: {
            url: "https://www.youtube.com/embed/gOGJKHXntiU",
            title: "Webiny Overview"
        }
    }
];

// Mount the component.
<RichTextRenderer data={content} renderers={customRenderers}/>;

Sanitization configuration

We are using sanitize-html package for content sanitization.

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.

import {
    RichTextRenderer,
    configureSanitization,
} from "@webiny/react-rich-text-renderer";

const globalSanitizaionConfig = {
    allowedTags: ["b", "i", "em", "strong", "a"],
    allowedAttributes: {
        a: ["href"],
    },
    allowedIframeHostnames: ["www.youtube.com"],
};

// This is global configuration.
configureSanitization(globalSanitizaionConfig);

/*
* Set sanitization configuration options for specific component. 
* Note: Provided configuration will override your global configuration options.
* */
const sanitizationConfig = {
    // change the configuration only for this option.
    allowedIframeHostnames: ["www.webiny.com"],
};

<RichTextRenderer sanitizationConfig={sanitizationConfig}/>;

Readme

Keywords

none

Package Sidebar

Install

npm i @webiny/react-rich-text-renderer

Weekly Downloads

276

Version

5.39.6

License

MIT

Unpacked Size

31.2 kB

Total Files

7

Last publish

Collaborators

  • webiny