Change record status: 
Project: 
Introduced in branch: 
9.1.x
Introduced in version: 
9.1-Beta7
Description: 

The Patternkit Beta 7 release adds support for using CKEditor 5 as packaged with Drupal core with WYSIWYG-enabled fields in Patternkit pattern forms. Configuration and usage remains the same as using CKEditor 4. A site administrator only needs to change the editor assigned to the selected format in Patternkit settings, and change the WYSIWYG editor selection to CKEditor 5. With this change in place, WYSIWYG-enabled fields in pattern schemas should now load with CKEditor 5 for editing.

Configuration Changes

  1. Enable the CKEditor5 module (ckeditor5)
  2. Configure a filter format to use CKEditor5 with desired configuration (/admin/config/content/formats)
  3. Edit the Patternkit settings under the "JSON Pattern Library Settings" tab (/admin/config/user-interface/patternkit/json):
    • Set "WYSIWYG editor" to CKEditor5
    • Select the configured filter format in the "CKEditor toolbar" field

CKEditor 5 should now be used on all pattern schema forms for fields with the following values:

{
  "type": "string",
  "format": "html",
  "options": {
    "wysiwyg": true
  }
}

Known Issues

#3354654: CKEditor 5 Content Filtering Doesn't Work

CKEditor 4 supported client-side restriction of what HTML elements were allowed and forbidden within the editor using the options.allowedContent and options.disallowedContent values set on schema fields. CKEditor 5 has changed the structure of this configuration such that the string values that were previously supported (like "a b strong em i[*](*){*}" as seen in the example example_filtered pattern) will no longer apply. Until a new solution is implemented, this functionality will not work when using CKEditor5 with Patternkit fields. The functionality continues to work when using CKEditor 4.

Impacts: 
Site builders, administrators, editors
Module developers