Skip to content
Export content from draft-js into an abstract syntax tree.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
lib
src
test
.babelrc
.eslintrc
.gitignore
.npmignore
.tool-versions
.travis.yml
CHANGELOG.md
LICENSE.md
README.md
package-lock.json
package.json

README.md

Draft.js AST Exporter

Allows you to export the content from Facebook’s Draft.js editor to an abstract syntax tree (AST). Together with the companion draft-js-ast-importer it forms the full cycle of exporting content from a Draft.js editor instance and then re-importing it.

Why?

Draft.js supports exporting its content JSON, but this format is a little awkward. Blocks of text are disconnected from their style and entity ranges, and the depth of blocks isn’t implicit. So when it comes to rendering that content in contexts outside a Draft.js editor, you need to have an understanding of how those ranges should be applied and how blocks fit together.

The AST generated by draft-js-ast-exporter mitigates this issue by joining common ranges together into marked inline or entity sections, and by allowing blocks to be nested within one another based on their depth.

Installation

npm install --save draft-js-ast-exporter

Usage

import exporter from 'draft-js-ast-exporter'
const ast = exporter(editorState)

Entity modification

You can modify the entity data as it’s being exported by passing in an options.entityModifiers object with a functions to modify that entity-type’s data:

import exporter from 'draft-js-ast-exporter'
const options = {
  entityModifiers: {
    'LINK': (data) => {
      let copy = Object.assign({}, data)
      // Strip protocols from `url` keys
      copy.url = copy.url.replace(/^https?:/, '')
      return copy
    }
  },
}
const ast = exporter(editorState, options)

This would be run for every entity type of LINK.

Output

A simple example of the AST output is included in the docs.

You can’t perform that action at this time.