Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rexxars/react-prosemirror-document
Render a ProseMirror document using React
https://github.com/rexxars/react-prosemirror-document
Last synced: 16 days ago
JSON representation
Render a ProseMirror document using React
- Host: GitHub
- URL: https://github.com/rexxars/react-prosemirror-document
- Owner: rexxars
- License: mit
- Created: 2016-01-18T20:26:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-03-10T21:02:24.000Z (over 4 years ago)
- Last Synced: 2024-05-02T00:08:15.773Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 22.5 KB
- Stars: 18
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-prosemirror-document
Render a ProseMirror document in JSON-format using React
## Installation
```
npm install --save react-prosemirror-document
```
## Usage
```js
var ProseMirrorDocument = require('react-prosemirror-document');
var pmDocument = {
type: 'doc',
content: [{
type: 'paragraph',
content: [{
type: 'text',
text: 'Lets add a link to '
}, {
type: 'text',
text: 'my website',
marks: [{
type: 'link',
href: 'https://espen.codes/',
title: 'Espen.Codes (personal website)'
}]
}, {
type: 'text',
text: ' for fun an profit.'
}]
}]
};
ReactDOM.render(, document.body)
```
## Props
- `document` - (**required**) *object* The JSON prosemirror document to render
- `typeMap` - *object* An object where the keys represent the types in a prosemirror document and the values refer to the component that should be used for rendering it. The default type map is overriden when using this, so if you just want to extend the defaults, be sure to use something like `Object.assign` or similar to merge your own types with the ones from `ProseMirrorDocument.typeMap`
- `markMap` - *object* An object where the keys represent the marks in a prosemirror document and the values refer to the component that should be used for rendering it. The default mark map is overriden when using this, so if you just want to extend the defaults, be sure to use something like `Object.assign` or similar to merge your own types with the ones from `ProseMirrorDocument.markMap`
- `skipUnknownMarks` - *boolean* Set to true to simply skip any unknown marks. Default is `false`, which will throw an error when encountering unknown marks.
- `skipUnknownTypes` - *boolean* Set to true to simply skip any unknown types. Default is `false`, which will throw an error when encountering unknown types.
## License
MIT-licensed, see LICENSE.