Merge pull request #13 from ueberdosis/feature/make-blockquotes-wrappable

make blockquotes wrappable
This commit is contained in:
Philipp Kühn 2020-09-27 09:30:11 +02:00 committed by GitHub
commit b926060f1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 49 additions and 13 deletions

View File

@ -22,6 +22,20 @@ context('/api/extensions/blockquote', () => {
.should('contain', 'Example Text') .should('contain', 'Example Text')
}) })
it('the button should wrap all nodes in a blockquote', () => {
cy.get('.ProseMirror').then(([{ editor }]) => {
editor.setContent('<p>Example Text</p><p>Example Text</p>')
editor.selectAll()
})
cy.get('.demo__preview button:first')
.click()
cy.get('.ProseMirror')
.find('blockquote')
.should('have.length', 1)
})
it('the button should toggle the blockquote', () => { it('the button should toggle the blockquote', () => {
cy.get('.ProseMirror blockquote') cy.get('.ProseMirror blockquote')
.should('not.exist') .should('not.exist')

View File

@ -77,12 +77,7 @@ const CustomExtension = new Node()
Dont forget to call `create()` in the end! Read more about [all the nifty details building custom extensions](/guide/custom-extensions) in our guide. Dont forget to call `create()` in the end! Read more about [all the nifty details building custom extensions](/guide/custom-extensions) in our guide.
### 4. Blockquotes must not be nested anymore ### 4. Renamed API methods
:::warning Breaking Change
Currently, blockquotes must not be nested anymore. That said, were working on bringing it back. If you use nested blockquotes in your app, dont upgrade yet.
:::
### 5. Renamed API methods
[We renamed a lot of commands](/api/commands), hopefully you can migrate to the new API with search & replace. Here is a list of what changed: [We renamed a lot of commands](/api/commands), hopefully you can migrate to the new API with search & replace. Here is a list of what changed:
| Old method name | New method name | | Old method name | New method name |
@ -90,11 +85,11 @@ Currently, blockquotes must not be nested anymore. That said, were working on
| ~~`getHTML`~~ | `html` | | ~~`getHTML`~~ | `html` |
| ~~`getJSON`~~ | `json` | | ~~`getJSON`~~ | `json` |
### 6. Commands can be chained now ### 5. Commands can be chained now
### 7. .focus() isnt called on every command anymore ### 6. .focus() isnt called on every command anymore
We tried to hide the `.focus()` command from you with tiptap 1 and executed that on every other command. That led to issues in specific use cases, where you want to run a command, but dont want to focus the editor. With tiptap 2.x you have to explicitly call the `focus()` and you probably want to do that in a lot of places. Here is an example: We tried to hide the `.focus()` command from you with tiptap 1 and executed that on every other command. That led to issues in specific use cases, where you want to run a command, but dont want to focus the editor. With tiptap 2.x you have to explicitly call the `focus()` and you probably want to do that in a lot of places. Here is an example:
```js ```js

View File

@ -18,3 +18,4 @@ export { toggleBlockType } from './toggleBlockType'
export { toggleList } from './toggleList' export { toggleList } from './toggleList'
export { toggleMark } from './toggleMark' export { toggleMark } from './toggleMark'
export { updateMark } from './updateMark' export { updateMark } from './updateMark'
export { toggleWrap } from './toggleWrap'

View File

@ -0,0 +1,26 @@
import { wrapIn, lift } from 'prosemirror-commands'
import { NodeType } from 'prosemirror-model'
import { Command } from '../Editor'
import nodeIsActive from '../utils/nodeIsActive'
import getNodeType from '../utils/getNodeType'
type ToggleWrapCommand = (typeOrName: string | NodeType, attrs?: {}) => Command
declare module '../Editor' {
interface Commands {
toggleWrap: ToggleWrapCommand,
}
}
export const toggleWrap: ToggleWrapCommand = (typeOrName, attrs) => ({
state, dispatch,
}) => {
const type = getNodeType(typeOrName, state.schema)
const isActive = nodeIsActive(state, type, attrs)
if (isActive) {
return lift(state, dispatch)
}
return wrapIn(type, attrs)(state, dispatch)
}

View File

@ -1,5 +1,5 @@
import { Command, Node } from '@tiptap/core' import { Command, Node } from '@tiptap/core'
import { textblockTypeInputRule } from 'prosemirror-inputrules' import { wrappingInputRule } from 'prosemirror-inputrules'
export type BlockquoteCommand = () => Command export type BlockquoteCommand = () => Command
@ -14,7 +14,7 @@ export const inputRegex = /^\s*>\s$/gm
export default new Node() export default new Node()
.name('blockquote') .name('blockquote')
.schema(() => ({ .schema(() => ({
content: 'inline*', content: 'block*',
group: 'block', group: 'block',
defining: true, defining: true,
draggable: false, draggable: false,
@ -24,14 +24,14 @@ export default new Node()
toDOM: () => ['blockquote', 0], toDOM: () => ['blockquote', 0],
})) }))
.commands(({ name }) => ({ .commands(({ name }) => ({
[name]: attrs => ({ commands }) => { [name]: () => ({ commands }) => {
return commands.toggleBlockType(name, 'paragraph', attrs) return commands.toggleWrap(name)
}, },
})) }))
.keys(({ editor }) => ({ .keys(({ editor }) => ({
'Shift-Mod-9': () => editor.blockquote(), 'Shift-Mod-9': () => editor.blockquote(),
})) }))
.inputRules(({ type }) => [ .inputRules(({ type }) => [
textblockTypeInputRule(inputRegex, type), wrappingInputRule(inputRegex, type),
]) ])
.create() .create()