Feature: Readonly support

CKEditor5 Plugin Pack Read-Only Mode Patch

Problem

When CKEditor5 text fields are set to `disabled` or `readonly`, core CKEditor5 plugins properly disable their toolbar buttons, but plugins from the `ckeditor5_plugin_pack` module (such as `fullscreen`, `findAndReplace`, `emoji`, `fontColor`, etc.) remain functional and their toolbar buttons are not disabled.

Solution

This patch adds JavaScript that ensures all CKEditor5 Plugin Pack plugins respect the read-only mode when fields are disabled or readonly.

Files Changed

1. js/ckeditor5_plugin_pack.readonly.js (new file)
- JavaScript behavior that detects disabled/readonly textareas
- Enforces read-only mode on CKEditor5 editors
- Disables all toolbar buttons including plugin pack plugins

2. ckeditor5_plugin_pack.libraries.yml
- Adds a new readonly_support library definition
- Includes the new JavaScript file with proper dependencies

3. ckeditor5_plugin_pack.module
- Implements hook_page_attachments_alter() to attach the readonly support library

How to Apply

Using Composer (Recommended)

If you're using composer-patches or cweagans/composer-patches:

1. Add the patch to your composer.json:

{
  "extra": {
    "patches": {
      "drupal/ckeditor5_plugin_pack": {
        "Fix readonly mode for plugin pack plugins": "patches/ckeditor5_plugin_pack_readonly.patch"
      }
    }
  }
}

2. Place the patch file in your patches/ directory (or adjust the path accordingly)

3. Run composer update drupal/ckeditor5_plugin_pack

Manual Application

1. Navigate to the module directory:

cd docroot/modules/contrib/ckeditor5_plugin_pack

2. Apply the patch:

patch -p1 < /path/to/ckeditor5_plugin_pack_readonly.patch

3. Clear Drupal cache:

drush cr

How It Works

1. The JavaScript behavior (Drupal.behaviors.ckeditor5PluginPackReadonly) runs on page load and AJAX updates
2. It finds all textareas with CKEditor5 attached that have disabled or readonly attributes
3. For each such textarea, it:
- Gets the CKEditor5 editor instance
- Enables read-only mode if not already enabled
- Explicitly disables all toolbar buttons (including plugin pack plugins)
4. If the editor hasn't initialized yet, it waits up to 2 seconds for it to become available

Testing

After applying the patch:

1. Create or edit a node with a CKEditor5 field
2. Set the field to disabled or readonly using form alter hooks:

$form['field_name']['#attributes']['readonly'] = 'readonly';
$form['field_name']['#disabled'] = TRUE;

3. Verify that:
- All toolbar buttons (including plugin pack plugins) are disabled
- The editor content is not editable
- Plugin pack plugins like fullscreen, findAndReplace, emoji, fontColor are non-functional

Compatibility

- Drupal Version: 10.x, 11.x
- CKEditor5 Plugin Pack: 1.4+
- CKEditor5 Core Module: Any version

Notes

- The patch works alongside the core CKEditor5 module's read-only mode handling
- It enhances the core functionality to ensure plugin pack plugins also respect read-only mode
- The library is attached on all pages, but the JavaScript only activates when CKEditor5 editors with disabled/readonly attributes are detected

Related Issues

This patch addresses the issue where:
- Core CKEditor5 plugins: ✅ Properly disabled in read-only mode
- Plugin Pack plugins: ❌ Not properly disabled in read-only mode (before patch)
- Plugin Pack plugins: ✅ Properly disabled in read-only mode (after patch)