Add CKeditor 5 support

Created on 11 January 2023, almost 2 years ago
Updated 5 May 2023, over 1 year ago

Problem/Motivation

CKEditor 4 is marked as deprecated in Drupal 9.5 ( https://www.drupal.org/project/drupal/issues/3304326 ) and will be removed in Drupal 10. We should provide a CKEditor 5-compatible version of the augmentor ckeditor plugin.

Proposed resolution

Add a CKEditor 5 plugin to the existing module (alongside the CKEditor 4 plugin) to simplify the migration path. The CKEditor 5 API is a ground-up rewrite, so it will require familiarity with that API.

Integration within Drupal should follow documentation provided below:

Feature request
Status

Fixed

Version

1.0

Component

Code

Created by

🇯🇵Japan eleonel Itoshima 🇯🇵

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇮🇳India naveenvalecha New Delhi

    Assigning that to myself will allow me to explore the CK5 API and an in-depth understanding of the CK4 integration.

  • Assigned to eleonel
  • 🇯🇵Japan eleonel Itoshima 🇯🇵

    HI Naveen, I'm already working on it and I have a work in progress module.

  • 🇮🇳India naveenvalecha New Delhi

    That's excellent news, Eleo!

  • 🇺🇸United States bogdog400

    I just tried Augmentor on Drupal 10 which comes with CKEditor 5 out of the box. So it's not really possible to test anything without this. Thanks for working on it.

  • 🇨🇳China fishfree

    @bogdog400 But in Drupal latest 9.x version, Augmentor is still not compatible with CKEditor 5, which is enabled by default.

  • @eleonel opened merge request.
  • Status changed to Needs review over 1 year ago
  • 🇯🇵Japan eleonel Itoshima 🇯🇵

    Ready for review.

  • 🇺🇸United States hyperlinked San Jose, CA

    It appears that not only does Augmentor only support CKeditor 4. It actually requires CKeditor 4 to be selected on the pages on which there is an Augmentor edit form widget. I tried numerous variations on a clean install.

    I tried numerous variations in a clean install:
    CKeditor 4 enabled, but not selected as the editor for a formatted textarea element.
    CKeditor 4 and 5 enabled, but CKeditor 5 selected as the editor.
    CKeditor 4 enabled, but no editor selected.
    CKeditor not installed at all.
    CKeditor 4 enabled and selected as the editor for at least one textarea.

    The only variation that works is the last one. If CKeditor 4 is not loaded on a page that has an Augmentor widget, the following JavaScript error is thrown when clicking on the Augmentor widget button:

    [Error] ReferenceError: Can't find variable: CKEDITOR

  • 🇯🇵Japan eleonel Itoshima 🇯🇵

    Thanks @hyperlinked,

    I created a separate issue for that, please check https://www.drupal.org/project/augmentor/issues/3358019 Separate Ckeditor 4 in a submodule Fixed

  • Status changed to Fixed over 1 year ago
  • 🇯🇵Japan eleonel Itoshima 🇯🇵
  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024