Page break

The page break feature lets you insert page breaks into your content. This gives you more control over the final structure of a document that is printed or exported to PDF or Word.

# Demo

Use the insert page break toolbar button to see the feature in action. Use the “Open print preview” button below the editor to preview the content.

# Installation

After installing the editor, add the feature to your plugin list and toolbar configuration:

import { ClassicEditor, PageBreak } from 'ckeditor5';

ClassicEditor
	.create( document.querySelector( '#editor' ), {
		licenseKey: '<YOUR_LICENSE_KEY>', // Or 'GPL'.
		plugins: [ PageBreak, /* ... */ ],
		toolbar: [ 'pageBreak', /* ... */ ],
	} )
	.then( /* ... */ )
	.catch( /* ... */ );

# Related features

Here are some useful CKEditor 5 features that you can use together with the page break plugin for an all-around paged editing experience:

• The pagination feature allows you to see where page breaks would be after the document is exported to PDF or to Word.
• The export to Word feature will allow you to generate editable, paged .docx files out of your editor-created content.
• The export to PDF feature will allow you to generate portable, paged PDF files out of your editor-created content.

# Common API

The PageBreak plugin registers:

• the UI button component ('pageBreak'),
• the 'pageBreak' command implemented by PageBreakCommand.

You can execute the command using the editor.execute() method:

// Inserts a page break into the selected content.
editor.execute( 'pageBreak' );

# Contribute

The source code of the feature is available on GitHub at https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-page-break.