Created
November 15, 2022 12:04
-
-
Save jacekkarczmarczyk/79e8d741fe965770092091a8cd116a90 to your computer and use it in GitHub Desktop.
TipTap PageBreak extension
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import { mergeAttributes, Node } from '@tiptap/core'; | |
import { TextSelection } from 'prosemirror-state'; | |
export interface PageBreakRuleOptions { | |
HTMLAttributes: Record<string, any>; | |
} | |
declare module '@tiptap/core' { | |
interface Commands<ReturnType> { | |
pageBreak: { | |
/** | |
* Add a page break | |
*/ | |
setPageBreak: () => ReturnType; | |
/** | |
* Remove a page break | |
*/ | |
unsetPageBreak: () => ReturnType; | |
}; | |
} | |
} | |
export const PageBreak = Node.create<PageBreakRuleOptions>({ | |
name: 'pageBreak', | |
addOptions () { | |
return { | |
HTMLAttributes: { | |
style: 'page-break-after: always', | |
'data-page-break': 'true', | |
}, | |
}; | |
}, | |
group: 'block', | |
parseHTML () { | |
return [ | |
{ | |
tag: 'div', | |
getAttrs: node => (node as HTMLElement).style.pageBreakAfter === 'always' && (node as HTMLElement).dataset.pageBreak === 'true' && null, | |
}, | |
]; | |
}, | |
renderHTML ({ HTMLAttributes }) { | |
return ['div', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes)]; | |
}, | |
addCommands () { | |
return { | |
setPageBreak: () => ({ chain }) => { | |
return chain() | |
.insertContent({ type: this.name }) | |
// set cursor after page break | |
.command(({ dispatch, tr }) => { | |
if (dispatch) { | |
const { $to } = tr.selection; | |
const posAfter = $to.end(); | |
if ($to.nodeAfter) { | |
tr.setSelection(TextSelection.create(tr.doc, $to.pos)); | |
} else { | |
// add node after page break if it’s the end of the document | |
const node = $to.parent.type.contentMatch.defaultType?.create({ | |
style: { | |
pageBreakAfter: 'always', | |
}, | |
'data-page-break': 'true', | |
}); | |
if (node) { | |
tr.insert(posAfter, node); | |
tr.setSelection(TextSelection.create(tr.doc, posAfter)); | |
} | |
} | |
tr.scrollIntoView(); | |
} | |
return true; | |
}) | |
.run(); | |
}, | |
unsetPageBreak: () => ({ chain }) => { | |
return chain() | |
.deleteSelection() | |
.command(() => true) | |
.run(); | |
}, | |
}; | |
}, | |
}); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
PHP extension: