@contentful/contentful-slatejs-adapter

contentful-slatejs-adapter

This library provides an adapter to convert Slate's document structure to Contentful's rich text document structure and vice-versa.

Installation

Using npm:

npm install @contentful/contentful-slatejs-adapter

Using yarn:

yarn add @contentful/contentful-slatejs-adapter

Usage

TBA

{
  "category": "document",
  "content": [
    {
      "category": "block",
      "type": "header-one",
      "content": [
        {
          "category": "text",
          "type": "text",
          "value": "This is a headline!",
          "marks": [
            {
              "object": "mark",
              "type": "bold",
              "data": {}
            }
          ]
        }
      ]
    },
    {
      "category": "block",
      "type": "paragraph",
      "content": [
        {
          "category": "text",
          "type": "text",
          "value": "",
          "marks": [
            {
              "object": "mark",
              "type": "bold",
              "data": {}
            }
          ]
        }
      ]
    },
    {
      "category": "block",
      "type": "paragraph",
      "content": [
        {
          "category": "text",
          "type": "text",
          "value": "and this is a bold text",
          "marks": [
            {
              "object": "mark",
              "type": "bold",
              "data": {}
            }
          ]
        },
        {
          "category": "text",
          "type": "text",
          "value": " but now i am not bold anymore. ",
          "marks": []
        },
        {
          "category": "text",
          "type": "text",
          "value": "However, ",
          "marks": [
            {
              "object": "mark",
              "type": "italic",
              "data": {}
            }
          ]
        },
        {
          "category": "text",
          "type": "text",
          "value": " i am now ",
          "marks": []
        },
        {
          "category": "text",
          "type": "text",
          "value": "underlined with shit. ",
          "marks": [
            {
              "object": "mark",
              "type": "underlined",
              "data": {}
            }
          ]
        }
      ]
    }
  ]
}

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