nodebb-plugin-composer-quill: WYSIWYG alternative to redactor

[JJSagan]

Hi @julien ,

As for fixing the teaser (issue #10):

There are two options,

1. Preferable: Fixing at the server - file src/messaging.js

Messaging.getTeaser = function (uid, roomId, callback) {

in line 235 add:

    if((teaser.content != null) && (teaser.content.hasOwnProperty("ops"))) {
	teaser.content = JSON.stringify(teaser.content);
}

try {
	var unescaped = teaser.content.replace(/"/g, '"');
	var content = JSON.parse(unescaped);
	var converter = new QuillDeltaToHtmlConverter(content.ops, {});
	teaser.content = converter.convert();
} catch (e) {
	// Do nothing
}

2. In the client: ./src/modules/chat.js:123

     ```
   

module.loadChatsDropdown = function (chatsListEl) {
		socket.emit('modules.chats.getRecentChats', {
			uid: app.user.uid,
			after: 0,
		}, function (err, data) {
			if (err) {
				return app.alertError(err.message);
			}

			var rooms = data.rooms.filter(function (room) {
                               if((room.teaser != null) && (room.teaser.hasOwnProperty("ops"))) {
                        		room.teaser = JSON.stringify(room.teaser);

     	                try {
		              var unescaped = room.teaser.replace(/"/g, '"');
		              var content = JSON.parse(unescaped);
		              var converter = new QuillDeltaToHtmlConverter(content.ops, {});
		              room.teaser = converter.convert();
	                  } catch (e) {
		             // Do nothing
	                     }

				return room.teaser;
			});

The above code was untested! I don't know how to override js files and keep my changes after pull

I really hope you'll consider positively making the changes in uploads.js and in messaging.js. They are very short and can really help thanks!

[JJSagan]

Pertaining tooltips (#3):

In action:composer:loaded add the following function call:

[Code was edited, so as to catch all buttons - some do not have <button tags]:

Call this function by:
		toolTip('.composer[data-uuid="' + data.post_uuid + '"]');


function toolTip (composer_selector) {
		let tooltips = {
			'bold': 'Help I am BOLD',
                        //your icons - perhaps add translate here
		};

		let showTooltip = (el, isSpan) => {
			let tool = (isSpan ? el.className.replace('span', '') : el.className.replace('ql-', '')).replace(/\s+/g, '.');

			if (tooltips[tool]) {
				console.log('toolTip: ' + tooltips[tool]);
				if(isSpan)
					document.querySelector(composer_selector + ' .' + tool).setAttribute('title', tooltips[tool]);
				else
					document.querySelector(composer_selector + ' .ql-' + tool).setAttribute('title', tooltips[tool]);
			}
		};

		let toolbarElement = document.querySelector(composer_selector + ' .ql-toolbar');
		if (toolbarElement) {
			let matches = toolbarElement.querySelectorAll('button');
			for (let el of matches) {
				showTooltip(el, false);
			}
			toolbarElement.querySelectorAll(':scope > span').forEach(function(element) {
				matches = element.querySelectorAll(':scope > span');
				for (let el of matches) {
					showTooltip(el, true);
				}
			});
		}

		//Enable tooltip
		$(composer_selector + ' [data-toggle="tooltip"]').tooltip();
	}

});

Till now I have documented all the changes I can take care of without changing the core code.

@julian Kindly consider changing composer/uploads.js to allow uploads from chat, and the server code to return the teasers properly - The changes are very small and are documented in the previous message.

Devs, quill can give composer-redactor a good beating.
Take a look, I bet you'll love it.
JJ.

[julian]

Oh yeah -- Redactor is old and not supported anymore because they don't have an open source license. It is their call not to have one, so I must respect that.

Quill is still in development, so I would love to take your changes into account. It is not quite production ready yet.... for one, I still have to build conversion tools to and from quill in case you switch composers.

[JJSagan]

@julian ,

Thank you kindly note that I am novice programmer and my code may be written better / more efficiently.

Did emoji work for you? cause I see that in the screenshots you have emoji icon displayed.
When I enable nodebb-plugin-emoji latest version (2.2.6) and push the icon I get:

emoji-dialog.js?v=bseib43d720:1 Failed to initialize emoji dialog TypeError: Cannot read property 'getBoundingClientRect' of undefined
    at o (emoji-dialog.js?v=bseib43d720:1)
    at emoji-dialog.js?v=bseib43d720:1

My guess is that emoji is trying to feed the editor but does not know how (due to the new format). I suggest to deal with that in quill plugin. Maybe @PitaJ may have some comments about that.

Another option is to install quill-emoji https://github.com/contentco/quill-emoji. I'll try that and report back.

Lastly, I believe the search plugin may need modification. Search may be enabled as follows:

• Getting the data to the server to remove the quill format (performance hit), or

• Double saving post data (once in quill format, and another just with text, removing quill json and html tags). That will consume more space but search can be done on the database with no performance hit.

• Searching as-is remembering that some words (like "insert") are reserved.

JJ.

[JJSagan]

Hi @julian ,

Just completed integrating quill-emoji lib. (https://github.com/contentco/quill-emoji)

First I should say that the icons will only display inside the editor, so you can't display them afterwards (without changes to the core nodebb files), nor they may be used outside the scope of the editor, for example, in a topic header. To that end, I suggest getting the standard emoji composer library to work.

if anyone wants to experiment, allow me to save you some time:

1. Update your dependencies in package.json:

"quill-emoji": "^0.1.2",

2. Update plugin.json:

         "css": [
		"./node_modules/quill/dist/quill.snow.css",
		"./node_modules/quill/dist/quill.bubble.css",
		"./node_modules/quill-emoji/dist/quill-emoji.css"
	],
        "modules": {
		"quill.js": "./node_modules/quill/dist/quill.js",
		"quill-emoji.js": "./node_modules/quill-emoji/dist/quill-emoji.js"
	},

3. update quill-nbb.js packages:

define('quill-nbb', [
	'quill',
	'quill-emoji',
	...
], function (Quill, QuillEmoji, ...

3. update quill-nbb.js quill icons:

var toolbarOptions = {
				container: [
					[ your icons],
					['emoji']
				],
				handlers: {
					'emoji': function () {}
				}

5. Update init():

		var quill = new Quill(targetEl.get(0), {
			theme: data.theme || 'snow',
			modules: {
				toolbar: toolbarOptions,
				"emoji-toolbar": true,
				"emoji-shortname": true,
				"emoji-textarea": true
			}
		});

That's it, you should be all set.
But as I said, this solution is inferior, a better solution is using nodebb-plugin-emoji.
@PitaJ , see my previous message with the error code. Will appreciate some help thanks!

JJ.

[PitaJ]

@JJSagan could you get a screenshot of where the error occurs in the code? You might need to run in dev mode if the sourcemaps don't work.

[JJSagan]

This post is deleted!

[JJSagan]

The issue occurs in emoji.js at line 100:

exports.search = fuzzySearch;
            formatting.addButtonDispatch('emoji-add-emoji', function (textarea) {
                new Promise(function (resolve_4, reject_4) { require(['emoji-dialog'], resolve_4, reject_4); }).then(function (_a) {
                    var toggleForInsert = _a.toggleForInsert;
                    return toggleForInsert(textarea);  //!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! this line
                });
            });
            if (callback) {
                setTimeout(callback, 0);
            }

[JJSagan]

This post is deleted!

[JJSagan]

Line 100 toggleForInsert(textarea) articulates the issue I discussed earlier.

Unfortunately with quill, one cannot write into the text area. The quill format is a bit different.

Maybe you can return a link to quill-nbb.js so we can take care of inserting the data property there.

Another option is for you to check if quill is in use, and then you may:
quill.insertText(ptr, markup_txt, {
"align": "??",
"color": "??",
});
where ptr is the point to which the icon should be inserted. I assume you are not saving a bitmap but a link. To that end please take a look at quill-nbb.js specifically at image upload. Once a link is uploaded quill can display it.

[julian]

While I don't like to have individual plugins integrate with Quill, sometimes it is necessary. For example, many plugins detect whether Redactor is in use, and hook methods directly into Redactor.

It is my hope that this will not be necessary with Quill, but one never knows -- with regard to the emoji in my screenshots, the emoji plugin works fine with Quill but only if you type in the :smile: code yourself. Otherwise it will not work as you discovered, because the plugin does not know how to insert text/images into the Quill contenteditable.

I do not have time this month to work on Quill, but there is hopefully time scheduled in October I look forward to getting it to 100% compatibility so we can bundle it with NodeBB in addition to composer-default.

[JJSagan]

Getting this plugin integrated into composer is a very desirable target, I believe.

If you need help with this, I can lend a hand. Do let me know if there are areas you'd like me to explore, so we'll get as much done by Oct.

[Kosiak]

Hi! How to install Quill Composer? I can't find it in NPM

[JJSagan]

Hi @Kosiak
You'll have to clone it from here: https://github.com/NodeBB/nodebb-plugin-composer-quill
Its not PnP, yet... so get yourself ready for few code changes - no biggie, just follow the above.
Good luck!
JJ.

[Kosiak]

Hi @JJSagan
Ohh, I see. I'm not a coder. I'm just starting to learn NodeBB. I'm looking for something to install through the admin area. Thx!

[JJSagan]

No problemo @Kosiak , do check back on this plugin after October.
If you are looking for WYSIWYG then I believe this could be the solution for you, since Redactor unfortunately may be on its way out.
Take care and good luck with your forum!
btw: i started few months ago as none-coder like you (and yeah I still suck...), so be careful you might get addicted and convert

[JJSagan]

Hi @PitaJ .

I am trying to debug nodebb-plugin-emoji and make it work with quill.

I cloned your depository, and compiled, however I can't see the sourcemaps of emoji-dialog.ts.

I tried changing tsconfig.json to include: "inlineSourceMap": true, "inlineSources": true, but still no sourcemap. Interestingly, emoji-setup.js does have a sourcemap.

Any idea what I am doing wrong?
Thank you!
JJ.

[JJSagan]

Hi @PitaJ

Its difficult without a debugger, but I am quite confident the issue stem from showDeferred function - see init in emoji-dialog.js and look for getBoundingClientRect.
Either tabContent[0] or elem (from callback) are undefined.

The above code gets executed upon clicking the emoji icon in quill, that is, as a result of the dispatcher:

formatting.addButtonDispatch('emoji-add-emoji', function (textarea) {
                new Promise(function (resolve_4, reject_4) { require(['emoji-dialog'], resolve_4, reject_4); }).then(function (_a) {
                    var toggleForInsert = _a.toggleForInsert;
                    return toggleForInsert(textarea);
                });
            });

Console output:

Failed to initialize emoji dialog TypeError: Cannot read property 'getBoundingClientRect' of undefined
    at n (emoji-dialog.js?v=q79j5o5953s:1)
    at emoji-dialog.js?v=q79j5o5953s:1

I wonder if this gives you any clue with regards to a potential fix.
JJ.

[PitaJ]

@JJSagan I'll look into it and see if I can find a solution in the coming days.

[JJSagan]

Hi @julian and @PitaJ

While reviewing the composer redactor code, I noted you are using a special set of emojis, rather than nodebb-plugin-emoji.

To that end, I took another look at rendering the quill-emoji plugin (https://github.com/contentco/quill-emoji), that is, without using a deadbeat quill editor. See an earlier post how to install.

The solution was to write a customized rendering code using converter.renderCustomWith(). See my suggested changes to library.js:

plugin.parseRaw = function (raw, callback) {
        //Convert delta strings
	if((raw != null) && (raw.hasOwnProperty("ops"))) {
		raw = JSON.stringify(raw);
	}

	try {
		var unescaped = raw.replace(/"/g, '"');
		var content = JSON.parse(unescaped);
		var converter = new QuillDeltaToHtmlConverter(content.ops, {});

		converter.renderCustomWith(function(customOp, contextOp){
			if (customOp.insert.type === 'emoji') {
				return `<span class="${customOp.attributes.class}" src="${customOp.insert.value}"><span contenteditable="false"></span></span>`;
			} else {
				return 'Unmanaged custom blot!';
			}
		});

		raw = converter.convert();
	} catch (e) {
		// Do nothing
		winston.warn('[composer-quill] Input not in expected format, skipping. - ', raw);
	}

	callback(null, raw);
};

I'll play with it some more, but so far it looks solid.
Perhaps its better to use quill-emoji (over nodebb-plugin-emoji), to insure long term compatibility with quill.

JJ.