guidePagination - quick start

This article aims to get you up and running with CKEditor 5 pagination in your CKEditor Premium Features free trial.

Follow the steps below:

# Subscribe to the CKEditor Premium Features free trial

Create an account by signing up for CKEditor Premium Features free trial. After signing up, you will receive access to the customer dashboard (CKEditor Ecosystem dashboard).

CKEditor Premium Features free trial sign-up view.

You will be asked to check the features you are most interested in.

Checking these features does not affect the trial bundle contents — all the features will be available regardless of the choice. We just want to know your needs better.

# Log in to the CKEditor Ecosystem dashboard

Log in to the CKEditor Ecosystem dashboard. You will receive a confirmation email and will be asked to create a password for your account. Keep it safe.

# Account dashboard

After logging in, click “CKEditor” under the “Your products” header on the left. You will see the subscription parameters overview together with the management area below.

Your CKEditor trials view in the customer dashboard.

# Generate the license key

Once you enter the management console for track changes, comments, revision history, and pagination, you have access to the license key needed to run these features. Note that the same license key will be valid for all three features.

Pagination license key in the management console.

# Integrating the pagination feature with CKEditor 5

To install the plugin into your WYSIWYG editor, use the online builder to generate a custom CKEditor 5 build with the plugin enabled. Alternatively, refer to the installation guide in the plugin documentation to do it on your own.

To set up the feature, you need to add the license key to your CKEditor 5 configuration as described in the installation guide.

Apart from setting the license key, the configuration of this feature in the editor is the key to allowing pagination to measure where the page breaks would be and to produce a 1:1 result with the export to PDF or Word features. Refer to the configuration section of the Pagination feature guide for more information.

# Compatibility issues

Currently, the pagination feature works best with the following web browsers:

  • Chrome
  • Chromium
  • latest Edge
  • latest Opera

The pagination plugin does not work in Firefox as of yet. There are also some glitches in Safari. To prevent users from seeing potentially invalid pagination, the plugin disables itself after detecting these unsupported browsers.

# Enabling pagination in unsupported browsers

If you want to enable the pagination feature on unsupported browsers anyway, you can set the config.pagination.enableOnUnsupportedBrowsers configuration option to true or enable it at the runtime by calling editor.plugins.get( 'Pagination' ).clearForceDisabled( 'browserCheck' ).