README.md

Strapi Blocks React Renderer

Easily render the content of Strapi's new Blocks rich text editor in your React frontend.

Installation

Install the Blocks renderer and its peer dependencies:

yarn add @strapi/blocks-react-renderer react react-dom

npm install @strapi/blocks-react-renderer react react-dom

Basic usage

After fetching your Strapi content, you can use the BlocksRenderer component to render the data from a blocks attribute. Pass the array of blocks coming from your Strapi API to the content prop:

import { BlocksRenderer, type BlocksContent } from '@strapi/blocks-react-renderer';

// Content should come from your Strapi API
const content: BlocksContent = [
  {
    type: 'paragraph',
    children: [{ type: 'text', text: 'A simple paragraph' }],
  },
];

const App = () => {
  return <BlocksRenderer content={content} />;
};

Custom components

You can provide your own React components to the renderer, both for blocks and modifier. They will be merged with the default components, so you can override only the ones you need.

• Blocks are full-width elements, usually at the root of the content. The available options are:
  • paragraph
  • heading (receives level)
  • list (receives format)
  • quote
  • code (receives plainText)
  • image (receives image)
  • link (receives url)
• Modifiers are inline elements, used to change the appearance of fragments of text within a block. The available options are:
  • bold
  • italic
  • underline
  • strikethrough
  • code

To provide your own components, pass an object to the blocks and modifiers props of the renderer. For each type, the value should be a React component that will receive the props of the block or modifier. Make sure to always render the children, so that the nested blocks and modifiers are rendered as well.

import { BlocksRenderer } from '@strapi/blocks-react-renderer';

// Content should come from your Strapi API
const content = [
  {
    type: 'paragraph',
    children: [{ type: 'text', text: 'A simple paragraph' }],
  },
];

const App = () => {
  return (
    <BlocksRenderer
      content={content}
      blocks={{
        // You can use the default components to set class names...
        paragraph: ({ children }) => <p className="text-neutral900 max-w-prose">{children}</p>,
        // ...or point to a design system
        heading: ({ children, level }) => {
          switch (level) {
            case 1:
              return <Typography variant="h1">{children}</Typography>
            case 2:
              return <Typography variant="h2">{children}</Typography>
            case 3:
              return <Typography variant="h3">{children}</Typography>
            case 4:
              return <Typography variant="h4">{children}</Typography>
            case 5:
              return <Typography variant="h5">{children}</Typography>
            case 6:
              return <Typography variant="h6">{children}</Typography>
            default:
              return <Typography variant="h1">{children}</Typography>
          }
        },
        // For links, you may want to use the component from your router or framework
        link: ({ children, url }) => <Link to={url}>{children}</Link>,
      }}
      modifiers={{
        bold: ({ children }) => <strong>{children}</strong>,
        italic: ({ children }) => <span className="italic">{children}</span>,
      }}
    />
  );
};