Contribute to this guide

guideCKEditor 5 DLL builds

The purpose of a DLL build is to allow adding plugins to an editor build without having to rebuild (recompile) the build itself.

So far, the two most common integration methods included:

  • Using pre-compiled builds. This can be either one of the official builds or a custom build. In this case, adding a plugin requires recompiling the entire build.
  • Integrating the editor from source. In this case, if you want to add a plugin, your application needs to be recompiled.

In some advanced use cases, the list of available plugins cannot be limited — it should be possible to add plugins without any access to Node.js. In other words, plugins should be built (compiled) separately from the editor’s core.

This is where the DLL builds come to the rescue.

DLL builds are based on the DLL webpack plugin that provides a CKEditor 5 base DLL and a set of DLL consumer plugins.

Currently, CKEditor 5 does not come with a ready-to-use DLL build. Using this integration method requires creating it on your own, based on the tools available in the CKEditor 5 development environment.

Follow the Ship CKEditor 5 DLLs issue for updates (and add 👍 if you are interested in this functionality).

# Anatomy of a DLL build

A DLL build of the editor consists of two parts:

  • Base DLL build. It is a single JavaScript file that combines the contents of several core CKEditor 5 packages: utils, core, engine, ui, clipboard, enter, paragraph, select-all, typing, undo, upload, and widget. These packages are either the framework core, or are features used by nearly all editor installations.
  • DLL-compatible package builds. Every package that is not part of the base DLL build is built into a DLL-compatible JavaScript file.

In order to load an editor, you need to use the base DLL build plus several DLL-compatible package builds. You will see how to do that later on.

# Creating a DLL build

In order to create your own base DLL build and DLL-compatible packages builds, all you need to do is:

  1. Set up the CKEditor 5 development environment locally.
  2. Run npm run dll:build.

The base DLL build can be found in ./build/ckeditor5-dll.js.

The DLL-compatible builds of other packages can be found in ./packages/ckeditor5-*/build/<pkg-name>.js. For example: ./packages/ckeditor5-image/build/image.js.

This is it.

# Using a DLL build

The exact way to use a DLL build will depend on your system. Presented in this guide is the simplest method that uses the <script> tags.

In order to run the editor, you need to load the necessary files (base DLL + editor creator + features). These files expose their content in the CKEditor5 global, using the following format:

CKEditor5.packageName.moduleName

For example:

<!-- Base DLL build. -->
<!-- Note: It includes ckeditor5-paragraph too. -->
<script src="path/to/ckeditor5/build/ckeditor5-dll.js"></script>

<!-- DLL-compatible build of ckeditor5-editor-classic. -->
<script src="path/to/ckeditor5/packages/ckeditor5-editor-classic/build/editor-classic.js"></script>

<!-- DLL-compatible builds of editor features. -->
<script src="path/to/ckeditor5/packages/ckeditor5-autoformat/build/autoformat.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-basic-styles/build/basic-styles.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-block-quote/build/block-quote.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-essentials/build/essentials.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-heading/build/heading.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-image/build/image.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-indent/build/indent.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-link/build/link.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-list/build/list.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-media-embed/build/media-embed.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-paste-from-office/build/paste-from-office.js"></script>
<script src="path/to/ckeditor5/packages/ckeditor5-table/build/table.js"></script>

<script>
    const config = {
        plugins: [
            CKEditor5.basicStyles.Bold,
            CKEditor5.basicStyles.Italic,
            CKEditor5.autoformat.Autoformat,
            CKEditor5.blockQuote.BlockQuote,
            CKEditor5.essentials.Essentials,
            CKEditor5.heading.Heading,
            CKEditor5.image.Image,
            CKEditor5.image.ImageCaption,
            CKEditor5.image.ImageStyle,
            CKEditor5.image.ImageToolbar,
            CKEditor5.image.ImageUpload,
            CKEditor5.indent.Indent,
            CKEditor5.link.Link,
            CKEditor5.list.List,
            CKEditor5.mediaEmbed.MediaEmbed,
            CKEditor5.paragraph.Paragraph,
            CKEditor5.pasteFromOffice.PasteFromOffice,
            CKEditor5.table.Table,
            CKEditor5.table.TableToolbar
        ],
        toolbar: {
            items: [
                'heading',
                '|',
                'bold',
                'italic',
                'link',
                'bulletedList',
                'numberedList',
                '|',
                'outdent',
                'indent',
                '|',
                'uploadImage',
                'blockQuote',
                'insertTable',
                'mediaEmbed',
                'undo',
                'redo'
            ]
        },
        image: {
            toolbar: [
                'imageStyle:full',
                'imageStyle:side',
                '|',
                'imageTextAlternative'
            ]
        },
        table: {
            contentToolbar: [
                'tableColumn',
                'tableRow',
                'mergeTableCells'
            ]
        }
    };

    CKEditor5.editorClassic.ClassicEditor
        .create( document.querySelector( '#editor' ), config )
        .then( editor => {
            window.editor = editor;
        } );