category: features
The {@link module:page-break/pagebreak~PageBreak} plugin provides a possibility to insert a page break into the rich-text editor. This is useful in paged editing scenarios where you want to have more control over the final structure of the document that is printed, exported to PDF or to Word.
The page break feature is further complemented by the pagination feature that allows you to see where page breaks would be after the document is exported to PDF or to Word.
Use the editor to see the {@link module:page-break/pagebreak~PageBreak} plugin in action. Click the button below in order to open the print preview window.
{@snippet features/page-break}
Here are some useful CKEditor 5 features that you can use together with the page break plugin for an all-around paged editing experience:
.docx files out of your editor-created content.To add this feature to your rich-text editor, install the @ckeditor/ckeditor5-page-break package:
npm install --save @ckeditor/ckeditor5-page-break
And add it to your plugin list configuration:
import PageBreak from '@ckeditor/ckeditor5-page-break/src/pagebreak';
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ PageBreak, ... ],
toolbar: [ 'pageBreak', ... ],
} )
.then( ... )
.catch( ... );
Read more about {@link builds/guides/integration/installing-plugins installing plugins}.
The {@link module:page-break/pagebreak~PageBreak} plugin registers:
'pageBreak'),'pageBreak' command implemented by {@link module:page-break/pagebreakcommand~PageBreakCommand}.The command can be executed using the {@link module:core/editor/editor~Editor#execute editor.execute()} method:
// Inserts a page break into the selected content.
editor.execute( 'pageBreak' );
We recommend using the official {@link framework/guides/development-tools#ckeditor-5-inspector CKEditor 5 inspector} for development and debugging. It will give you tons of useful information about the state of the editor such as internal data structures, selection, commands, and many more.
The source code of the feature is available on GitHub in https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-page-break.