Plugin and Contrib module development

Last updated on
14 September 2022

This page has not yet been reviewed by CKEditor 5 module maintainer(s) and added to the menu.

This documentation needs work. See "Help improve this page" in the sidebar.

Creating a Drupal module

See https://api.drupal.org/api/drupal/core%21modules%21ckeditor5%21ckeditor5.api.php/group/ckeditor5_architecture/10.0.x#plugins for how to define CKEditor 5 plugins in a Drupal module.

The JS files in packages can be used directly in a Drupal module without any further build step, for example packages/ckeditor5-horizontal-line/build/horizontal-line.js.

Creating a custom CKEditor 5 plugin

See https://www.drupal.org/project/ckeditor5_dev for how to create custom CKEditor 5 plugins, using a starter template that also generates a Drupal module.

Example: https://www.drupal.org/project/ckeditor5_dev/issues/3258194.

For the actual CKEditor 5 plugin JavaScript APIs, see:

  1. Creating a basic plugin
  2. Abbreviation plugin tutorial – part 1

Help improve this page

Page status: Needs work

You can: