Skip to content

Commit

Permalink
Merge pull request #254 from mayacoda/master
Browse files Browse the repository at this point in the history
allow parseOptions to be passed to setContent and Editor constructor
  • Loading branch information
philippkuehn authored Apr 11, 2019
2 parents 24f61e0 + b3f8f1b commit 7a17b56
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 5 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ export default {
| `extensions` | `Array` | `[]` | A list of extensions used, by the editor. This can be `Nodes`, `Marks` or `Plugins`. |
| `useBuiltInExtensions` | `Boolean` | `true` | By default tiptap adds a `Doc`, `Paragraph` and `Text` node to the Prosemirror schema. |
| `dropCursor` | `Object` | `{}` | Config for `prosemirror-dropcursor`. |
| `dropCursor` | `Object` | `{}` | A list of [Prosemirror parseOptions](https://prosemirror.net/docs/ref/#model.ParseOptions). |
| `onInit` | `Function` | `undefined` | This will return an Object with the current `state` and `view` of Prosemirror on init. |
| `onFocus` | `Function` | `undefined` | This will return an Object with the `event` and current `state` and `view` of Prosemirror on focus. |
| `onBlur` | `Function` | `undefined` | This will return an Object with the `event` and current `state` and `view` of Prosemirror on blur. |
Expand All @@ -81,7 +82,7 @@ export default {

| **Method** | **Arguments**| **Description** |
| --- | :---: | --- |
| `setContent` | `content, emitUpdate` | Replace the current content. You can pass an HTML string or a JSON document. `emitUpdate` defaults to `false`. |
| `setContent` | `content, emitUpdate, parseOptions` | Replace the current content. You can pass an HTML string or a JSON document. `emitUpdate` defaults to `false`. `parseOptions` defaults to those provided in constructor. |
| `clearContent` | `emitUpdate` | Clears the current content. `emitUpdate` defaults to `false`. |
| `setOptions` | `options` | Overwrites the current editor properties. |
| `registerPlugin` | `plugin` | Register a Prosemirror plugin. |
Expand Down
9 changes: 5 additions & 4 deletions packages/tiptap/src/Editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export default class Editor {
},
useBuiltInExtensions: true,
dropCursor: {},
parseOptions: {},
onInit: () => {},
onUpdate: () => {},
onFocus: () => {},
Expand Down Expand Up @@ -185,7 +186,7 @@ export default class Editor {
})
}

createDocument(content) {
createDocument(content, parseOptions = this.options.parseOptions) {
if (content === null) {
return this.schema.nodeFromJSON(this.options.emptyDocument)
}
Expand All @@ -203,7 +204,7 @@ export default class Editor {
const element = document.createElement('div')
element.innerHTML = content.trim()

return DOMParser.fromSchema(this.schema).parse(element)
return DOMParser.fromSchema(this.schema).parse(element, parseOptions)
}

return false
Expand Down Expand Up @@ -321,10 +322,10 @@ export default class Editor {
return this.state.doc.toJSON()
}

setContent(content = {}, emitUpdate = false) {
setContent(content = {}, emitUpdate = false, parseOptions) {
this.state = EditorState.create({
schema: this.state.schema,
doc: this.createDocument(content),
doc: this.createDocument(content, parseOptions),
plugins: this.state.plugins,
})

Expand Down
49 changes: 49 additions & 0 deletions packages/tiptap/test/Editor.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,52 @@ test('update callback', done => {

editor.setContent('<p>Bar</p>', true)
})

test('parse options in set content', done => {
const editor = new Editor({
content: '<p>Foo</p>',
onUpdate: ({ getHTML, getJSON }) => {
expect(getHTML()).toEqual('<p> Foo </p>')
expect(getJSON()).toEqual({
type: 'doc',
content: [
{
type: 'paragraph',
content: [
{
type: 'text',
text: ' Foo ',
},
],
},
],
})
done()
},
})

editor.setContent('<p> Foo </p>', true, { preserveWhitespace: true })
})

test('parse options in constructor', () => {
const editor = new Editor({
content: '<p> Foo </p>',
parseOptions: { preserveWhitespace: true },
})

expect(editor.getHTML()).toEqual('<p> Foo </p>')
expect(editor.getJSON()).toEqual({
type: 'doc',
content: [
{
type: 'paragraph',
content: [
{
type: 'text',
text: ' Foo ',
},
],
},
],
})
})

0 comments on commit 7a17b56

Please sign in to comment.