Contribute to this guide

guideConfiguration

Quick recap

In the previous tutorial you have learned about the quickest ways for setting up CKEditor 5 in the project. Now, you know how to use online builder or create the editor from source. It is time to play a bit with the configuration!

When creating an editor in your page, it is possible to set up configurations that change many of its aspects. For example:

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        toolbar: [ 'heading', '|', 'bold', 'italic', 'link', 'bulletedList', 'numberedList', 'blockQuote' ],
        heading: {
            options: [
                { model: 'paragraph', title: 'Paragraph', class: 'ck-heading_paragraph' },
                { model: 'heading1', view: 'h1', title: 'Heading 1', class: 'ck-heading_heading1' },
                { model: 'heading2', view: 'h2', title: 'Heading 2', class: 'ck-heading_heading2' }
            ]
        }
    } )
    .catch( error => {
        console.log( error );
    } );

As you can see, the configuration is set by a simple JavaScript object passed to the create() method.

# Removing features

The predefined CKEditor 5 builds come with all the features included in the distribution package enabled by default. They are defined as plugins for CKEditor 5.

In some cases, you may want to have different editor setups in your application, all based on the same build. For that purpose, you need to control the plugins available in the editor at runtime.

In the example below, the Heading plugin is removed:

// Remove a plugin from the default setup.
ClassicEditor
    .create( document.querySelector( '#editor' ), {
        removePlugins: [ 'Heading' ],
        toolbar: [ 'bold', 'italic', 'bulletedList', 'numberedList', 'blockQuote' , 'link' ]
    } )
    .catch( error => {
        console.log( error );
    } );

You might want to delete the Link plugin also, as shown below:

// Remove a few plugins from the default setup.
ClassicEditor
    .create( document.querySelector( '#editor' ), {
        removePlugins: [ 'Heading', 'Link' ],
        toolbar: [ 'bold', 'italic', 'bulletedList', 'numberedList', 'blockQuote' ]
    } )
    .catch( error => {
        console.log( error );
    } );

However, using this snippet with the official classic build of CKEditor 5 will result in an error thrown in the console of the browser:

CKEditorError: plugincollection-required {"plugin":"Link","requiredBy":"CKFinder"}`
Read more: https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/error-codes.html#error-plugincollection-required

This is a good time to remind you that some plugins in CKEditor 5 depend on each other. In this case, the CKFinder plugin requires the Link plugin to work. To make the above snippet work, the CKFinder plugin must also be deleted:

// Remove a few plugins from the default setup.
ClassicEditor
    .create( document.querySelector( '#editor' ), {
        removePlugins: [ 'Heading', 'Link', 'CKFinder' ],
        toolbar: [ 'bold', 'italic', 'bulletedList', 'numberedList', 'blockQuote' ]
    } )
    .catch( error => {
        console.log( error );
    } );

Be careful when removing plugins from CKEditor builds using config.removePlugins. If removed plugins were providing toolbar buttons, the default toolbar configuration included in a build will become invalid. In such case you need to provide the updated toolbar configuration as in the example above or by providing only toolbar items that need to be removed using config.toolbar.removeItems.

# List of plugins

Each build has a number of plugins available. You can easily list all plugins available in your build:

ClassicEditor.builtinPlugins.map( plugin => plugin.pluginName );

# Adding features

# Adding complex features

As predefined CKEditor 5 builds do not include all possible features, the only way to add more features to them is to create a custom build.

# Adding simple (standalone) features

There is an exception to every rule. Although it is impossible to add plugins that have dependencies to @ckeditor/ckeditor5-core or @ckeditor/ckeditor5-engine (that includes nearly all existing official plugins) without rebuilding the build, it is still possible to add simple, dependency-free plugins.

You can do that using the config.extraPlugins configuration. The plugin interface allows plugins to be simple functions and you can define them in just a few lines, for instance:

function MyPlugin( editor ) {
    // ...
}

or

class MyPlugin {
    constructor( editor ) {
        // ...
    }

    init() {
        // ...
    }
}

An example plugin that you may want to add this way is a custom upload adapter.

import ClassicEditor from '@ckeditor/ckeditor5-build-classic';

function MyUploadAdapterPlugin( editor ) {
    editor.plugins.get( 'FileRepository' ).createUploadAdapter = function( loader ) {
        // ...
    };
}

// Load the custom upload adapter as a plugin of the editor.
ClassicEditor
    .create( document.querySelector( '#editor' ), {
        extraPlugins: [ MyUploadAdapterPlugin ],

        // ...
    } )
    .catch( error => {
        console.log( error );
    } );

# Toolbar setup

In the builds that contain toolbars an optimal default configuration is defined for it. You may need a different toolbar arrangement, though, and this can be achieved through configuration. Check the detailed toolbar feature guide for the available options.

When you create a custom build using CKEditor 5 online builder, setting up your toolbar configuration is one of the steps in the build creation process that uses an intuitive drag and drop interface.

# Other configuration options

See EditorConfig to learn about all available configuration options.

Some of the options may require loading plugins which are not available in the build you use. Return to the Quick start guide for instructions on creating a custom build.

What’s next?

You have learned how to configure your own CKEditor 5 instance. Awesome! In the next tutorial, you will learn more about extending your editor with plugins. Ready for a ride? Jump in!