Add possibility to specify javascript code for mention plugin config

[merwok]

Hello! Thanks for publishing and maintaining this module!

Mention plugin was added in #131 but we can only configure a static list of matches in our settings, which are then dumped with json_script template filter and loaded by the js app using JSON.parse.

A static list has limited utility. The plugin can take a javascript callback, which could then call a view to get matches (docs).

Another feature requiring code is the customization of the output.

Could you add a mechanism to let us specify callbacks for this plugin?

[merwok]

I am currently trying this hack:

--- static/django_ckeditor_5/app.js
+++ static/django_ckeditor_5/app.js
@@ -81,6 +81,12 @@ function createEditors(element = document.body) {
                    var regex = new RegExp(match[1], match[2]);
                    return regex;
                 }
+                if (value.toString().startsWith('-CALLBACK-:')) {
+                   var callbackName = value.toString().split(':')[1]
+                   // callback must be installed as a global function first
+                   var callback = window[callbackName]
+                   return callback;
+                }
                 return value;
             }
         );

[merwok]

I could not run npx yarn run prod locally, but used your workflows config to build on github – thanks!

PR in my forked repo: https://github.com/caravancoop/django-ckeditor-5/pull/1/files

I can confirm this works. It is not the most elegant things… Two points could be better:

• the marker string
• get the function from e.g. window.djangoCkeditor5Callbacks rather than window

[merwok]

A cleaner way would be to introduce a little class say JavaScriptFunctionName that gets serialized correctly.

[merwok]

Alternative: pass function code as a string in config. See https://github.com/lulzcasz/django-tinymce/blob/7a8b54221fa37bf12d08b9dde4776ede985dc6e7/tinymce/static/django_tinymce/init_tinymce.js#L12-L38