Plank CMS - React Renderer

React renderer for Plank CMS rich text content. Converts the Tiptap JSON output from the RichText field into React elements, with full support for custom components per node type.

Installation

npm install @plank-cms/react-renderer
# or
pnpm add @plank-cms/react-renderer

Requires React ≥ 18 as a peer dependency.

Usage

Pass the content field from any Plank CMS entry directly — it accepts both the raw JSON string (as returned by the API) and a pre-parsed object.

import { PlankRenderer } from "@plank-cms/react-renderer";

export default function ArticlePage({ entry }) {
  return <PlankRenderer content={entry.content} />;
}

Custom components

Override any node or mark renderer via the components prop. Only the nodes you provide will be replaced — the rest use the built-in defaults.

<PlankRenderer
  content={entry.content}
  components={{
    heading: ({ level, children }) => (
      <h1 className={`heading-${level}`}>{children}</h1>
    ),
    blockquote: ({ children }) => (
      <blockquote className="border-l-4 pl-4 italic">{children}</blockquote>
    ),
    link: ({ href, target, rel, children }) => (
      <a
        href={href}
        target={target}
        rel={rel}
        className="text-blue-500 underline"
      >
        {children}
      </a>
    ),
    image: ({ src, alt, title, width, height }) => (
      <Image
        src={src}
        alt={alt ?? ""}
        title={title ?? undefined}
        width={width ?? 800}
        height={height ?? 600}
        className="rounded-lg"
      />
    ),
  }}
/>

Default styles

The package ships a pre-compiled stylesheet with sensible defaults. Import it once in your project:

@import "@plank-cms/react-renderer/styles.css";

All styles are scoped to the .plank-renderer class applied to the wrapper <div>, so they won't affect the rest of your layout. Override any node via the components prop to apply your own classes or styles instead.

Automatic spacing control

Default components now receive two optional props when rendered at the top level:

• isLast: true if the node is the last child in the document.
• isOnly: true if the node is the only child in the document.

These props allow avoiding bottom spacing (for example margin-bottom) on the last or only block. The props are optional and custom components continue to work if you don't use them.

Additionally, the renderer will add inline margin-bottom: 0 and padding-bottom: 0 to the last/only top-level block (isLast/isOnly) to neutralize utility classes (e.g. Tailwind pb-*). Custom components can opt-in to read these props but no change is required for correct results.

Example of a custom component that respects the flag:

heading: ({ level, children, isLast, isOnly }) => (
  <h2 style={{ marginBottom: isLast || isOnly ? 0 : undefined }}>{children}</h2>
),

Supported nodes

| Node | Default output | | ----------------- | ----------------------------------------------------------------------- | | heading (h1–h3) | <h1>–<h3> with scaled font sizes, bold weight, and vertical margins | | paragraph | <p> with bottom margin | | bulletList | <ul> with disc markers and bottom margin | | orderedList | <ol> with decimal markers and bottom margin | | listItem | <li> with small bottom margin | | blockquote | <blockquote> with left border, padding, and italic | | codeBlock | <pre><code> with monospace font, background, and scroll | | image | <img> or <figure><img /><figcaption /></figure> with image metadata |

Supported marks

bold, italic, underline, strike, code, link

Image captions

When a Tiptap image node includes attrs.title, the default renderer uses it in two places:

• as the image title attribute
• as a visible <figcaption> under the image

This matches Plank CMS rich text images where the media subtitle is inserted into Tiptap as title.

License

MIT - AM25, S.A.S. DE C.V.