@ckeditor/ckeditor5-page-break

What is @ckeditor/ckeditor5-page-break?

@ckeditor/ckeditor5-page-break is a plugin for CKEditor 5 that allows users to insert page breaks into their content. This is particularly useful for content that will be printed or exported to PDF, as it helps to control the layout and pagination.

What are @ckeditor/ckeditor5-page-break's main functionalities?

Insert Page Break

This feature allows users to insert a page break into the content. The page break is represented by a horizontal line in the editor, and it ensures that the content following the break starts on a new page when printed or exported.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ PageBreak, ... ], toolbar: [ 'pageBreak', ... ] })

Custom Page Break Label

This feature allows users to customize the label of the page break. By default, the label is 'Page Break', but it can be changed to any custom text.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ PageBreak, ... ], toolbar: [ 'pageBreak', ... ], pageBreak: { label: 'My Custom Page Break' } })

0

README

CKEditor 5 page break feature

This package implements the page break feature for CKEditor 5.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Demo

Check out the demo in the page break feature guide.

Documentation

See the @ckeditor/ckeditor5-page-break package page as well as the page break feature guide in the CKEditor 5 documentation.

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.