@contentful/rich-text-plain-text-renderer

What is @contentful/rich-text-plain-text-renderer?

@contentful/rich-text-plain-text-renderer is an npm package that provides functionality to convert Contentful's rich text documents into plain text. This can be useful for scenarios where you need to extract and manipulate text content without any formatting or HTML tags.

What are @contentful/rich-text-plain-text-renderer's main functionalities?

Convert Rich Text to Plain Text

This feature allows you to convert a Contentful rich text document into a plain text string. The code sample demonstrates how to use the `documentToPlainTextString` function to achieve this.

const { documentToPlainTextString } = require('@contentful/rich-text-plain-text-renderer');
const richTextDocument = {
  nodeType: 'document',
  content: [
    {
      nodeType: 'paragraph',
      content: [
        {
          nodeType: 'text',
          value: 'Hello, world!',
          marks: [],
          data: {}
        }
      ],
      data: {}
    }
  ],
  data: {}
};
const plainText = documentToPlainTextString(richTextDocument);
console.log(plainText); // Output: 'Hello, world!'

Other packages similar to @contentful/rich-text-plain-text-renderer

html-to-text

The `html-to-text` package converts HTML content into plain text. It is more general-purpose compared to @contentful/rich-text-plain-text-renderer, which is specifically designed for Contentful's rich text format. However, `html-to-text` can be used for a wider range of HTML content.

turndown

The `turndown` package is a highly customizable HTML to Markdown converter. While it focuses on converting HTML to Markdown, it can also be used to strip HTML tags and extract plain text. This makes it a versatile tool for text extraction, though it is not specifically tailored for Contentful's rich text format.

sanitize-html

The `sanitize-html` package is used to clean up and sanitize HTML content by removing unwanted tags and attributes. While its primary purpose is to sanitize HTML, it can also be configured to strip all tags, effectively converting HTML to plain text. This package offers more control over the sanitization process compared to @contentful/rich-text-plain-text-renderer.

README

rich-text-plain-text-renderer

Plain text renderer for the Rich Text document.

Installation

Using npm:

npm install @contentful/rich-text-plain-text-renderer

Using yarn:

yarn add @contentful/rich-text-plain-text-renderer

Usage

import { documentToPlainTextString } from '@contentful/rich-text-plain-text-renderer';

const document = {
  nodeType: 'document',
  data: {},
  content: [
    {
      nodeType: 'paragraph',
      data: {},
      content: [
        {
          nodeType: 'text',
          value: 'Hello',
          marks: [{ type: 'bold' }],
          data: {}
        },
        {
          nodeType: 'text',
          value: ' world!',
          marks: [{ type: 'italic' }],
          data: {}
        },
      ],
    },
  ]
};

documentToPlainTextString(document); // -> Hello world!

Changelog

14.1.2 (2020-11-02)

Bug Fixes

• 🐛 configure rollup copy correctly (3446a33)
• 🐛 skip lib check for TS (e8bf2ba)
• Add leaf object (#5) (fb0b80d)
• Add lodash.omit to externals (#7) (1c65200)
• Remove doc deployment and fix (90bccaa)

Features

• Add a default value for Marks (6828215)
• Add data transform (#6) (9d90fa1)
• Cleans up the mark property from extra props (20ec641)
• contentful-to-slate: Implement new isVoid in Slate's Node (3d2d38d)
• data defaults to an empty object (0a9b8a0)
• first version (11591d0)
• integrate structured-text-types (#8) (d6d5e37)
• remove content from void nodes (0ce9898)
• Remove nodeClass from Contentful's Document (23bb2d5)
• update dependencies (e294233)
• Update structured-text-type version (#9) (ced65da)

Performance Improvements

• ⚡️ Remove lodash.omit dependency (93b6b76)

BREAKING CHANGES

• Remove nodeClass from Contentful's Document
• Changed the interface of Slate->Contentful adapter. Added new parameter Schema
• contentful-to-slate: toSlatejsDocument now accepts Schema
• Only supports structured-text-types >= 2.0.0