Contribute to this guide

guideCKEditor 5 Framework overview

CKEditor 5 is a project that allows you to quickly and easily initialize one of the many types of editors it offers in your application. At the same time, it is a framework for creating custom-tailored rich-text editing solutions. The former requirement is met thanks to the editor type presets. The latter – thanks to CKEditor 5 Framework.

CKEditor 5 Framework is a highly-flexible and universal platform that provides a set of components allowing you to create any kind of rich text editing solution. It enables the building of different, custom-tailored editors that suit specific needs. It also provides tools for the creation and integration of user-made features and for customizing existing ones.

This guide explains how the framework is built and how to start using it.

Please note that the CKEditor 5 Framework documentation is constantly updated and expanded, but it may still be lacking some things. Feel free to suggest documentation enhancements and share your feedback about the framework.

If the documentation is insufficient, do not be afraid to look into the source code of CKEditor 5 packages. For example, if you plan to create a new feature, check if a similar one already exists and try to take inspiration from its source code.

# When to use the framework?

The CKEditor 5 Builder provides an easy way to create a custom-tailored installation, but certain types of customizations require using the framework.

  • Writing your own features. New features are implemented using the framework.
  • Customizing existing features. Changing the behavior or look of existing features can be done thanks to the framework’s capabilities.
  • Creating new types of editors. You can create new editor types using the framework.

To sum up: you need to start using the framework as soon as existing builds do not meet your requirements or cannot be customized to the extent you need.

# Contents of this section

This section of CKEditor 5 documentation provides the following resources accessible from the left-hand menu (or main menu button in the upper-left corner on mobile systems):

  • Tutorials – A crash course, a basic tutorial and advanced guides for any developers keep on writing their own CKEditor 5 plugins.
  • Development tools – A set of useful tooling and resources for anyone wanting to develop their editor.
  • Architecture – Intro-duction to the main pillars of CKEditor 5’s architecture.
  • Deep dive – Further Framework information for advanced developers.
  • How-tos – If you just need to know how to set the height of CKEditor 5 or learn how to focus the editor, this is the right section!