ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

move history plugin to extension package

Browse Source
This commit is contained in:
Philipp Kühn
2018-08-25 21:33:06 +02:00
parent bf1a091c94
commit deb8cb33b0
21 changed files with 108 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -84,6 +84,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -106,6 +107,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
}
},
@@ -130,7 +132,8 @@ The most powerful feature of tiptap is that you can create you own extensions. T
| `get name()` | `String` | `null` | Define a name for your extension. |
| `get defaultOptions()` | `Object` | `{}` | Define some default options. The options are available as `this.$options`. |
| `get plugins()` | `Array` | `[]` | Define a list of [Prosemirror plugins](https://prosemirror.net/docs/guide/). |
| `get inputRules()` | `Array` | `[]` | Define a list of input rules. |
| `keys({ schema })` | `Object` | `null` | Define some keybindings. |
| `inputRules({ schema })` | `Array` | `[]` | Define a list of input rules. |
### Node|Mark Class

2
examples/Components/Routes/Basic/index.vue
View File

@@ -132,6 +132,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -155,6 +156,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
}
},

2
examples/Components/Routes/Embeds/index.vue
View File

@@ -33,6 +33,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
import Iframe from './Iframe.js'
@@ -57,6 +58,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
// custom extension
new Iframe(),
],

2
examples/Components/Routes/HidingMenuBar/index.vue
View File

@@ -118,6 +118,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -141,6 +142,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
}
},

2
examples/Components/Routes/Links/index.vue
View File

@@ -53,6 +53,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -76,6 +77,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
linkUrl: null,
linkMenuIsActive: false,

2
examples/Components/Routes/MarkdownShortcuts/index.vue
View File

@@ -35,6 +35,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -58,6 +59,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
}
},

2
examples/Components/Routes/MenuBubble/index.vue
View File

@@ -62,6 +62,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -85,6 +86,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
}
},

2
examples/Components/Routes/ReadOnly/index.vue
View File

@@ -32,6 +32,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -55,6 +56,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
}
},

2
examples/Components/Routes/TodoList/index.vue
View File

@@ -84,6 +84,7 @@ import {
Code,
Italic,
Link,
History,
} from 'tiptap-extensions'
export default {
@@ -107,6 +108,7 @@ export default {
new Code(),
new Italic(),
new Link(),
new History(),
],
}
},

1
packages/tiptap-extensions/package.json
View File

@@ -20,6 +20,7 @@
"url": "https://github.com/heyscrumpy/tiptap/issues"
},
"dependencies": {
"prosemirror-history": "^1.0.2",
"tiptap": "^0.5.1",
"tiptap-commands": "^0.2.0"
}

30
packages/tiptap-extensions/src/extensions/History.js Normal file
View File

@@ -0,0 +1,30 @@
import { Extension } from 'tiptap'
import { history, undo, redo } from 'prosemirror-history'
export default class HistoryExtension extends Extension {
get name() {
return 'history'
}
keys() {
const isMac = typeof navigator !== 'undefined' ? /Mac/.test(navigator.platform) : false
const keymap = {
'Mod-z': undo,
'Shift-Mod-z': redo,
}
if (!isMac) {
keymap['Mod-y'] = redo
}
return keymap
}
get plugins() {
return [
history(),
]
}
}

2
packages/tiptap-extensions/src/index.js
View File

@@ -12,3 +12,5 @@ export { default as Bold } from './marks/Bold'
export { default as Code } from './marks/Code'
export { default as Italic } from './marks/Italic'
export { default as Link } from './marks/Link'
export { default as History } from './extensions/History'

1
packages/tiptap/package.json
View File

@@ -26,7 +26,6 @@
"dependencies": {
"prosemirror-commands": "^1.0.7",
"prosemirror-gapcursor": "^1.0.2",
"prosemirror-history": "^1.0.2",
"prosemirror-inputrules": "^1.0.1",
"prosemirror-keymap": "^1.0.1",
"prosemirror-model": "^1.5.0",

2
packages/tiptap/src/components/editor.js
View File

@@ -2,7 +2,6 @@ import { EditorState, Plugin } from 'prosemirror-state'
import { EditorView } from 'prosemirror-view'
import { Schema, DOMParser } from 'prosemirror-model'
import { gapCursor } from 'prosemirror-gapcursor'
import { history } from 'prosemirror-history'
import { keymap } from 'prosemirror-keymap'
import { baseKeymap } from 'prosemirror-commands'
import { inputRules } from 'prosemirror-inputrules'
@@ -165,7 +164,6 @@ export default {
keymap(builtInKeymap),
keymap(baseKeymap),
gapCursor(),
history(),
new Plugin({
props: {
editable: () => this.editable,

45
packages/tiptap/src/utils/ExtensionManager.js
View File

@@ -35,6 +35,7 @@ export default class ExtensionManager {
get views() {
return this.extensions
.filter(extension => ['node', 'mark'].includes(extension.type))
.filter(extension => extension.view)
.reduce((views, { name, view }) => ({
...views,
@@ -43,30 +44,60 @@ export default class ExtensionManager {
}
keymaps({ schema }) {
return this.extensions
const extensionKeymaps = this.extensions
.filter(extension => ['extension'].includes(extension.type))
.filter(extension => extension.keys)
.map(extension => extension.keys({ schema }))
const nodeMarkKeymaps = this.extensions
.filter(extension => ['node', 'mark'].includes(extension.type))
.filter(extension => extension.keys)
.map(extension => extension.keys({
type: schema[`${extension.type}s`][extension.name],
schema,
}))
.map(keys => keymap(keys))
return [
...extensionKeymaps,
...nodeMarkKeymaps,
].map(keys => keymap(keys))
// return this.extensions
// .filter(extension => ['node', 'mark'].includes(extension.type))
// .filter(extension => extension.keys)
// .map(extension => extension.keys({
// type: schema[`${extension.type}s`][extension.name],
// schema,
// }))
// .map(keys => keymap(keys))
}
inputRules({ schema }) {
return this.extensions
const extensionInputRules = this.extensions
.filter(extension => ['extension'].includes(extension.type))
.filter(extension => extension.inputRules)
.map(extension => extension.inputRules({ schema }))
const nodeMarkInputRules = this.extensions
.filter(extension => ['node', 'mark'].includes(extension.type))
.filter(extension => extension.inputRules)
.map(extension => extension.inputRules({
type: schema[`${extension.type}s`][extension.name],
schema,
}))
.reduce((allInputRules, inputRules) => ([
...allInputRules,
...inputRules,
]), [])
return [
...extensionInputRules,
...nodeMarkInputRules,
].reduce((allInputRules, inputRules) => ([
...allInputRules,
...inputRules,
]), [])
}
commands({ schema, view }) {
return this.extensions
.filter(extension => ['node', 'mark'].includes(extension.type))
.filter(extension => extension.command)
.reduce((commands, { name, type, command }) => ({
...commands,

8
packages/tiptap/src/utils/builtInKeymap.js
View File

@@ -1,18 +1,10 @@
import { lift, selectParentNode } from 'prosemirror-commands'
import { undo, redo } from 'prosemirror-history'
import { undoInputRule } from 'prosemirror-inputrules'
import isMac from './isMac'
const keymap = {
'Mod-z': undo,
'Shift-Mod-z': undo,
'Mod-BracketLeft': lift,
Backspace: undoInputRule,
Escape: selectParentNode,
}
if (!isMac) {
keymap['Mod-y'] = redo
}
export default keymap

4
packages/tiptap/src/utils/extension.js
View File

@@ -27,4 +27,8 @@ export default class Extension {
return []
}
keys() {
return {}
}
}

1
packages/tiptap/src/utils/index.js
View File

@@ -2,6 +2,5 @@ export { default as buildMenuActions } from './buildMenuActions'
export { default as builtInKeymap } from './builtInKeymap'
export { default as ComponentView } from './ComponentView'
export { default as initNodeViews } from './initNodeViews'
export { default as isMac } from './isMac'
export { default as menuBubble } from './menuBubble'
export { default as ExtensionManager } from './ExtensionManager'

1
packages/tiptap/src/utils/isMac.js
View File

@@ -1 +0,0 @@
export default typeof navigator !== 'undefined' ? /Mac/.test(navigator.platform) : false

4
packages/tiptap/src/utils/mark.js
View File

@@ -22,8 +22,4 @@ export default class Mark extends Extension {
return () => {}
}
keys() {
return {}
}
}

4
packages/tiptap/src/utils/node.js
View File

@@ -22,8 +22,4 @@ export default class Node extends Extension {
return () => {}
}
keys() {
return {}
}
}