slate-serializers

slate-serializers

A collection of serializers to convert Slate JSON objects to various formats and vice versa. Designed to work in both Node.js and browser environments.

Serializers included so far:

• slateToHtml
• htmlToSlate

Installation

yarn add slate-serializers
# or
npm install slate-serializers

Example usage:

import { slateToHtml, htmlToSlate } from 'slate-serializers'

const slate = [
  {
    children: [
      {
        text: 'Heading 1',
      },
    ],
    type: 'h1',
  },
  {
    children: [
      {
        text: 'Paragraph 1',
      },
    ],
    type: 'p',
  },
]

const serializedToHtml = slateToHtml(slate)
// output
// <h1>Heading 1</h1><p>Paragraph 1</p>

// ...and convert back to Slate
const serializedToSlate = htmlToSlate(serializedToHtml)

Details

slateToHtml

Based on logic in Deserializing | Serializing | Slate.

htmlparser2 is used to parse HTML instead of the DOMHandler object. Rationale:

• Works in all environments, including Node.js.
• Speed - htmlparser2 is the fastest HTML parser.
• Forgiving regarding HTML spec compliance.

Options

You may get better results passing the enforceTopLevelPTags option.

slateToHtml(slate, {enforceTopLevelPTags: true})

Objects in the Slate JSON can have no type (e.g. p) and contain a number of children. This causes issues for the serializer, which renders each child at the top of the DOM. Example: Paragraph 1.Paragraph 2.. Complexity is increased when text marks are involved such as u, strong and i.

To avoid this, enforceTopLevelPTags ensures any top level objects without a type are assigned as a p tag. Example: <p>Paragraph 1.</p><p>Paragraph 2.</p>.

htmlToSlate

Based on logic in HTML | Serializing | Slate.

Development

Commits

TLDR: contributors can format commit messages in any way, maintainers should use conventional commits.

This repository uses conventional commits.

Conventional commits are not enforced. General guidance:

• Commit messages can be formatted in any way on a pull request.
• Conventional commit messages are preferred on pull request squash and merge.

Run npx cz instead of git commit to lint commit messages using @commitlint/cli.