@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.

Changelog

44.1.0 (December 16, 2024)

We are pleased to announce the latest CKEditor 5 release, focusing on performance enhancements and key bug fixes to improve your editing and collaboration experience.

Release Highlights

⚡ Performance enhancements: Part 3

This release introduces another set of performance related improvements, focused on faster editor initialization for huge documents. The initialization time was lowered by further 15% to 45%, depending on the tested sample.

The combined improvements introduced in recent releases amount to around 65%-80% lower loading time in total, which means the editor will load 3-5x faster. As the gain is not linear, bigger documents see even better improvement (more than 10x faster).

Moreover, all these improvements positively impact document save time (editor.getData()), which should help with autosave issues, among others.

We still actively work in this area, so you may expect even more editor load and save efficiency improvements in the upcoming releases.

🔨 Bug Fixes and improvements

• Comments enhancements:
  • Data export options: We introduced the showCommentHighlights option in editor.getData(), that changes the comment marker conversion, allowing for styling comments in the output. Perfect for showing what was commented in Export to PDF, for example.
  • Inline mode improvements: We addressed a problem where comment annotations in inline mode did not close properly when clicking elsewhere in the content.
  • Thread management: We resolved an issue where creating a new thread was not interrupted when the corresponding marker was removed from the content, ensuring better stability during collaborative editing.
• Revision History update:
  • Restore functionality: We disabled the ability to restore the current (edited, not saved) revision, as it represents current content, so there is nothing to restore. At the same time, using it led to some non-obvious behaviors.
• Image handling: We resolved an issue where images in the uploading state could be deleted when dragged and dropped within the editor. Keep dragging, even when it is not there 🙈.

🎄 Happy holidays!

As the holiday season approaches, we extend our warmest wishes to our community and users. Thank you for your continued support, and we look forward to bringing you further enhancements and exciting features in the coming year.