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:

Issue fork augmentor-3332583

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

eleonel created an issue. See original summary.

murrayw’s picture

murrayw commented
Assigned: Unassigned » eleonel
naveenvalecha’s picture

naveenvalecha
He/Him
commented
Version: 1.0.0 » 1.0.x-dev
Assigned: eleonel » naveenvalecha

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

eleonel’s picture

eleonel
he/him
Primary language Spanish
Location Itoshima 🇯🇵
commented
Assigned: naveenvalecha » eleonel

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

naveenvalecha’s picture

naveenvalecha
He/Him
commented

That's excellent news, Eleo!

bogdog400’s picture

bogdog400 commented

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.

fishfree’s picture

fishfree commented

@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 !7

eleonel’s picture

eleonel
he/him
Primary language Spanish
Location Itoshima 🇯🇵
commented
Status: Active » Needs review

Ready for review.

hyperlinked’s picture

hyperlinked
he/him
Location San Jose, CA
commented

It appears that not only does Augmentor only support CKeditor 4. It's actually dependent upon CKeditor 4 being active on the pages on which there is an Augmentor edit form widget.

I tried these 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, Augmentor will either hang or abort when the widget button is clicked and the following JavaScript error is thrown:

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

eleonel’s picture

eleonel
he/him
Primary language Spanish
Location Itoshima 🇯🇵
commented

Thanks @hyperlinked,

I created a separate issue for that, please check https://www.drupal.org/project/augmentor/issues/3358019

  • eleonel committed 799b8c71 on 1.0.x 
    Issue #3332583 by eleonel: Add CKeditor 5 support
eleonel’s picture

eleonel
he/him
Primary language Spanish
Location Itoshima 🇯🇵
commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.