Trigger event when Text Editor is attached

What do y'all think about this patch? It tweaks Drupal.editors[editor].attach so it expects a promise and then dispatches an editor:attached event.

I was doing a really odd work around before finding this issue.

        const observer = new MutationObserver((mutationsList) => {
          mutationsList.forEach((mutation) => {
            if (mutation.attributeName === 'data-ckeditor5-id') {
              var waitForEditor = setInterval((ckeditor5Id, textArea) => {
                const editor = Drupal.CKEditor5Instances.get(ckeditor5Id);
                if (editor) {

                  // Do stuff ...

                  clearInterval(waitForEditor);
                  observer.disconnect();
                }
              }, 50, mutation.target.dataset.ckeditor5Id, mutation.target);
            }
          });
        });
        observer.observe(field, {attributes: true});

Custom commands...

😬

The Needs Review Queue Bot → tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.

should be 11.x even

+++ b/core/modules/editor/js/editor.js
@@ -297,7 +297,18 @@
+      const editorAttachPromise = Drupal.editors[format.editor].attach(
+        field,
+        format,
+      );
+      editorAttachPromise.then(
+        (editor) => {
+          $(document).trigger('editor:attached', [editor]);
+        },
+        (error) => {
+          console.log(`Failed to attach editor.\n${error}`);
+        },
+      );

I'd do away with the editorAttachPromise variable and simply call .then() after the .attach().

Also it would be better to use a catch instead of the second parameter of the then method.

Wow, that was quick! Thanks for reviewing! Yes indeed, that is more concise. 👍🏻

Could we add some test coverage for this new feature?

Also could some of the missing pieces of the issue summary be updated just to help the review

Thanks!.

I just opened MR, so it is easier to manage, review, and update the code. It contains same changes as the patch in #13. I just could not apply the patch for the latest D10, so re-rolled it in MR.

It looks like some extra white space was added when re-rolling #13 into an MR.

Removed the whitespaces mentioned in #18 and rebased the branch on 11.x

Was able to spin up an instance using the MR and write a custom module that ties into this event. Seems to work great!

((Drupal, $) => {

  Drupal.behaviors.testEditorAttachment = {
    attach() {

      console.log('behavior attached');

      $(document).on('editor:attached', function (event, editor) {
        if (typeof editor !== "undefined") {
          console.log('Event works!', event, editor);

          editor.setData('<p>Hello world!</p>');
        }
      });

    }
  };

})(Drupal, jQuery);

It's wishful thinking, but it'd be nice if this used native web Event Listeners rather than jQuery events, to reduce another need for jQuery in the large scheme of things, but it works as expected.

I won't mark as RTBC since this needs tests, but this is definitely something I could use in my current projects.

Would it be possible to roll this for 10.1? Is there a reason it must wait til 11?

Re-rolled patch to work with Drupal 10.1.7

The current patch direction does not account for editors that do not return a Promise. This results in a JS error, like that below:

Uncaught TypeError: Drupal.editors[format.editor].attach(...).then is not a function

Example: Try creating an Ace Editor text format and then switching to it, and then try switching back to a CKEditor 5 type format.

Re-rolled for Drupal 10.2.3 with Promise.resolve() change per #22

Can we get these changes back into the MR? Core doesn't really use a patch workflow any more.

Fixed up MR and merged #24 back into it. I've hid all the patches.

Thanks for turning to an MR.

Moving to NW for the tests and issue summary update.

The patch #24 does not work with 10.3.1. I have recreated the patch to ensure it is compatible with version 10.3.1.