Changes for page MentionsMacro

Summary

• Objects (3 modified, 0 added, 0 removed)
  • XWiki.JavaScriptExtension[0]
  • XWiki.StyleSheetExtension[0]
  • XWiki.WikiMacroClass[0]

Details

XWiki.JavaScriptExtension[0]

Code

...	...	@@ -1,15 +1,16 @@
1	1	require.config({
2	2	paths: {
3		- 'xwiki-suggestUsers': $jsontool.serialize($xwiki.getSkinFile('uicomponents/suggest/suggestUsersAndGroups.js'))
	3	+ 'xwiki-suggestUsers': "$xwiki.getSkinFile('uicomponents/suggest/suggestUsersAndGroups.js', true))" +
	4	+ "?v=$escapetool.url($xwiki.version)"
4	4	}
5	5	});
6	6	require(['deferred!ckeditor', 'xwiki-suggestUsers', 'jquery', 'xwiki-meta'], function (ckeditorPromise, suggestUsers, $, xm) {
7		-
	8	+
8	8	/**
9	9	* Get the current wiki scope for displaying global, local or global and local users
10	10	*/
11	11	const userScope = "$!services.wiki.user.userScope";
12		-
	13	+
13	13	// see https://stackoverflow.com/a/6248722/657524
14	14	function random6chars() {
15	15	// I generate the UID from two parts here
...	...	@@ -20,7 +20,7 @@
20	20	secondPart = ("000" + secondPart.toString(36)).slice(-3);
21	21	return firstPart + secondPart;
22	22	}
23		-
	24	+
24	24	/**
25	25	* Compute a new unique anchor for the given reference.
26	26	* The unique anchor is based on the mentionned user id, concatenaed with a random string of 6 alphanumeric
...	...	@@ -39,8 +39,8 @@
39	39	'input': text,
40	40	'limit': 6,
41	41	};
42		- suggestUsers.loadUsers(userScope, params).then(users => {
43		- const cct = users.map(function (x) {
	43	+ $.when(suggestUsers.loadUsers(userScope, params)).then(function (user) {
	44	+ const cct = user.map(function (x) {
44	44	// insert an id because that's required by the mentions plugins.
45	45	x.id = x.value;
46	46	// Make sure to display the icon avatar or the image one.
...	...	@@ -56,11 +56,11 @@
56	56	return x;
57	57	});
58	58	callback(cct);
59		- });
	60	+ })
60	60	}
61	61
62		- ckeditorPromise.then(ckeditor => {
63		- function getUserMentionsConfig(editor) {
	63	+ ckeditorPromise.done(function (ckeditor) {
	64	+ function confMentions(name) {
64	64	return {
65	65	feed: function (opts, callback) {
66	66	search(opts.query, callback);
...	...	@@ -68,21 +68,21 @@
68	68	marker: '@',
69	69	minChars: 0,
70	70	itemsLimit: 6,
71		- itemTemplate:
72		- `<li data-id="{id}" class="ckeditor-autocomplete-item">
73		- <div>
74		- <span class="ckeditor-autocomplete-item-icon-wrapper">
75		- <span class="{cssClass}"></span>
76		- <img src="{imgUrl}" class="{imgClass}"/>
77		- </span>
78		- <span class="ckeditor-autocomplete-item-label">{label}</span>
79		- </div>
80		- </li>`,
	72	+ itemTemplate: '<li data-id="{id}" class="ckeditor-autocomplete-item">'+
	73	+ '<div>'+
	74	+ '<span class="ckeditor-autocomplete-item-icon-wrapper">'+
	75	+ '<span class="{cssClass}"></span>'+
	76	+ '<img src="{imgUrl}" class="{imgClass}"/>'+
	77	+ '</span>'+
	78	+ '<span class="ckeditor-autocomplete-item-label">{label}</span>'+
	79	+ '</div>'+
	80	+ '</li>',
81	81	outputTemplate: function (param) {
82		- editor.once('afterInsertHtml', function() {
	82	+ var editor = ckeditor.instances[name];
	83	+ editor.once('afterInsertHtml', function () {
83	83	editor.execCommand('xwiki-macro-insert', {
84	84	name: 'mention',
85		- inline: 'enforce',
	86	+ inline: true,
86	86	parameters: {
87	87	reference: param.id,
88	88	style: 'FULL_NAME',
...	...	@@ -97,35 +97,21 @@
97	97	};
98	98	}
99	99
100		- // Enable the user mentions for the CKEditor instances that have been already created.
101		- Object.values(ckeditor.instances).forEach(maybeEnableUserMentions);
102		- // Enable the user mentions for the CKEditor instances that are going to be created from now on.
103		- ckeditor.on('instanceCreated', (event) => {
104		- maybeEnableUserMentions(event.editor);
105		- });
106		-
107		- function maybeEnableUserMentions(editor) {
108		- return waitForEditorReady(editor).then((editor) => {
109		- // Check if the Mentions plugin is enabled for the given editor instance.
110		- // TODO: Add support for disabling the user mentions for a particular editor instance (without disabling all
111		- // types of mentions).
112		- if (editor.plugins.mentions) {
113		- editor.plugins.mentions.instances.push(new ckeditor.plugins.mentions(editor, getUserMentionsConfig(editor)));
114		- }
115		- return editor;
116		- });
	101	+ function updateConf(config, name) {
	102	+ const newConf = config;
	103	+ newConf.mentions = newConf.mentions || [];
	104	+ newConf.mentions.push(confMentions(name));
	105	+ return newConf;
117	117	}
118	118
119		- function waitForEditorReady(editor) {
120		- return new Promise((resolve, reject) => {
121		- if (editor.status === 'ready') {
122		- resolve(editor);
123		- } else {
124		- editor.once('instanceReady', (event) => {
125		- resolve(event.editor);
126		- });
127		- }
128		- });
129		- }
	108	+ var oldReplace = ckeditor.replace;
	109	+ ckeditor.replace = function (element, config) {
	110	+ return oldReplace.call(this, element, updateConf(config, element.id));
	111	+ };
	112	+
	113	+ var oldInline = ckeditor.inline;
	114	+ ckeditor.inline = function (element, config) {
	115	+ return oldInline.call(this, element, updateConf(config, element.id));
	116	+ };
130	130	});
131	131	});

XWiki.StyleSheetExtension[0]

Code

...	...	@@ -1,6 +1,6 @@
1	1	.xwiki-mention {
2	2	background-color: $services.mentions.mentionsColor;
3		- border-radius: 10px;
	3	+ border-radius: 8px;
4	4	padding: 2px 5px 2px 5px;
5	5	}
6	6

XWiki.WikiMacroClass[0]

Macro code

...	...	@@ -11,8 +11,6 @@
11	11	#end
12	12	#set ($link = $xwiki.getURL($reference.reference, 'view'))
13	13	{{html}}
14		-<a id="$escapetool.xml($anchor)" class="$stringtool.join($cssClasses, ' ')" data-reference="$escapetool.xml($services.model.serialize($reference.reference, 'default'))" href="$escapetool.xml($link)">##
15		- $escapetool.xml($content)## Do not remove this comment as it ensures that the spacing after mention is not broken.
16		-</a>
	14	+<a id="$anchor" class="$stringtool.join($cssClasses, ' ')" data-reference="$services.model.serialize($reference.reference, 'default')" href="$link">$content</a>
17	17	{{/html}}
18	18	{{/velocity}}

Macro description

...	...	@@ -1,1 +1,1 @@
1		-Inserts a user mention.
	1	+Insert a user mention.

Default categories

...	...	@@ -1,1 +1,0 @@
1		-Notifications