Skip to Content

Wiki source code of XWiki JavaScript API

Version 45.1 by Simon Urli on 2022/01/12
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = Observable XWiki Events =
6
7 Stay in touch with what happens in the wiki! XWiki will fire custom javascript events on certain moment and upon certain actions that occur in the navigation flow.
8
9 Event names are build on the following model: ##xwiki:modulename:eventname##. Your JavaScript script or extension can get notified of such an event the following way:
10
11 {{code language="javascript"}}
12 document.observe("xwiki:modulename:eventname", function(event) {
13 // Here, do something that will be executed at the moment the event is fired
14 doSomething();
15
16 // The event can have an option memo object to pass to its observers some information:
17 console.log(event.memo.somethingINeedToKnow);
18 });
19 {{/code}}
20
21 Check out the real examples below or read more about [[Prototype.js's event system>>http://prototypejs.org/doc/latest/dom/Element/fire/]].
22
23 == DOM Events (xwiki.js) ==
24
25 * (((
26 **##xwiki:dom:loaded##**
27 This event is similar to [[prototype's dom:loaded event>>http://prototypejs.org/doc/latest/dom/document/observe/]], with the difference that in the time-lapse between ##dom:loaded## and ##xwiki:dom:loaded##, XWiki may have transformed the DOM. Example of DOM transformations operated by XWiki is setting the right target of links that have rel="external" attribute so that the document can be XHTML valid and still have the desired effect, making internal rendering error messages expandable, insert document template handlers for links to non-existent documents, and so on. In the future there might be more transformations operated by XWiki upon DOM initialization. This event is meant for code to be notified of loading of the XWiki-transformed version of the initial DOM. As ##dom:loaded##, it can be used as follows:(((
28 {{code language="javascript"}}
29 document.observe("xwiki:dom:loaded", function(){
30 // Initialization that can rely on the fact the DOM is XWiki-tranformed goes here.
31 });
32 {{/code}}
33 )))
34
35 (((
36 {{info}}
37 It is recommended to bind startup scripts to this event instead of ##window.load## or ##document.dom:loaded##.
38 {{/info}}
39 )))
40 )))
41
42 * **##xwiki:dom:loading##**
43 ##xwiki:dom:loading## is sent between ##dom:loaded## and ##xwiki:dom:loaded##, before XWiki changes the DOM. This is the event that should start all scripts making important DOM changes that other scripts should see.
44 * **##xwiki:dom:updated##**
45 This event is sent whenever an important change in the DOM occurs, such as loading new content in a dialog box or tab, or refreshing the document content. Scripts that add behavior to certain elements, or which enhance the DOM, should listen to this event as well and re-apply their initialization process on the updated content, the same way that the whole DOM is enhanced on ##xwiki:dom:loaded##. The list of new or updated elements is sent in the ##event.memo.elements## property. For example:(((
46 {{code language="javascript"}}
47 var init = function(elements) {
48 // Search for special content to enhance in each DOM element in the "elements" list and enhance it
49 elements.each(function(element) {
50 element.select('.someBehavioralClass').each(function(item) {
51 enhance(item);
52 });
53 });
54 }
55 ['xwiki:dom:loaded', 'xwiki:dom:updated'].each(function(eventName) {
56 document.observe(eventName, function(event) {
57 init(event.memo && event.memo.elements || [document.documentElement]);
58 });
59 });
60 {{/code}}
61
62 {{warning}}
63 If your script is loaded **deferred**, all these events may be triggered **before your script is executed** and therefore **before it has the ablity to observe these events**. Since 3.1.1, to prevent your handler to never being called, never use ##dom:loaded## anymore, and check ##XWiki.isInitialized## before waiting for ##xwiki:dom:loading##, and ##XWiki.domIsLoaded## before waiting for ##xwiki:dom:loaded##. If the flag is true, you should proceed immediately with your handler. Here is a simple construct to properly handle this:(((
64 {{code}}
65 function init() {
66 // This is your initialization handler, that you generally hook to xwiki:dom:loaded
67 }
68 (XWiki && XWiki.domIsLoaded && init()) || document.observe("xwiki:dom:loaded", init);
69 {{/code}})))
70 {{/warning}}
71
72 == Document content events (actionButtons.js) ==
73
74 * **##xwiki:document:saved##**
75 This event is sent after the document has been successfully saved in an asynchronous request (i.e. after clicking the //Save and Continue// button).
76 * **##xwiki:document:saveFailed##**
77 This event is sent when a save and continue attempt failed for some reason. The XMLHttpRequest response object is sent in the memo, as ##event.memo.response##.
78
79 == Action events (actionButtons.js) ==
80
81 * **##xwiki:actions:cancel##**
82 This event is sent after the user clicks the "Cancel" button of an editor (Wiki, WYSIWYG, object, rights, etc.), but before actually cancelling the edit.
83 * **##xwiki:actions:beforePreview##** (7.4.1+, 8.0M1+)
84 This event is sent after the user clicks the "Preview" button from an edit mode, but before the edit form is validated. You can use this event to update the form fields before they are submitted to the preview action.
85 * **##xwiki:actions:preview##**
86 This event is sent after the edit form has been validated, as a result of the user clicking the "Preview" button from an edit mode, but before the form is submitted. The event is fired only if the edit form is valid.
87 * **##xwiki:actions:beforeSave##** (7.4.1+, 8.0M1+)
88 This event is sent after the user clicks the "Save" or "Save & Continue" button from an edit mode, but before the edit form is validated. You can use this event to update the form fields before they are submitted to the save action.
89 * (((
90 **##xwiki:actions:save##**
91 This event is sent after the edit form has been validated, as a result of the user clicking the "Save" or "Save & Continue" button from an edit mode, but before the form is submitted. The event is fired only if the edit form is valid. A memo is available if you need to know if the intend is to continue after the save, in ##event.memo['continue']##. You can use it as follows:(((
92 {{code language="javascript"}}
93 document.observe("xwiki:actions:save", function(event){
94 var doContinue = event.memo['continue'];
95 if (doContinue) {
96 // do something specific
97 }
98 });
99 {{/code}}
100 )))
101
102 (((
103 {{warning}}
104 While most properties can be accessed as ##event.memo.property##, this doesn't work with ##event.memo.continue## since ##continue## is a reserved keyword.
105 {{/warning}}
106 )))
107
108 (((
109 All these events contain as extra information, in the second parameter sent to event listeners (the memo), the original click event (if any, and which can be stopped to prevent the action from completing), and the form being submitted, as ##event.memo.originalEvent##, and ##event.memo.form## respectively.
110 )))
111 )))
112
113 == Document extra events (xwiki.js) ==
114
115 * **##xwiki:docextra:loaded##**
116 This event is fired upon reception of the content of a document footer tab by AJAX. This event is useful if you need to operate transformations of the received content. You can filter on which tab content to operate (comments or attachment or information or ...) using the event memo. The DOM element in which the retrieved content has been injected is also passed to facilitate transformations.(((
117 {{code language="javascript"}}
118 document.observe("xwiki:docextra:loaded", function(event){
119 var tabID = event.memo.id;
120 if (tabID == "attachments") {
121 // do something with the attachments tab retrieved content.
122 doSomething(event.memo.element);
123 }
124 });
125 {{/code}}
126 )))
127 * **##xwiki:docextra:activated##**
128 This event is fired upon activation of a tab. It differs from the loaded event since tabs are loaded only once if the user clicks going back and forth between tabs. This event will notify of each tab activation, just after the tab content is actually made visible. The tab ID is passed in the memo as for ##xwiki:docextra:loaded##
129
130 == Suggest events (ajaxSuggest.js) ==
131
132 * **##xwiki:suggest:selected##** (since 2.3)
133 This event is fired on the target input when a value was selected.
134
135 == Fullscreen events (fullScreenEdit.js) ==
136
137 * **##xwiki:fullscreen:enter##** (since 3.0 M3) (fired before entering full screen editing)
138 * **##xwiki:fullscreen:entered##** (since 2.5.1) (fired after entering full screen editing)
139 * **##xwiki:fullscreen:exit##** (since 3.0 M3) (fired before exiting full screen editing)
140 * **##xwiki:fullscreen:exited##** (since 2.5.1) (fired after exiting full screen editing)
141 * **##xwiki:fullscreen:resized##** (since 2.5.1)
142
143 All events have the target DOM element in ##event.memo.target##.
144
145 == Annotations events (AnnotationCode/Settings jsx) ==
146
147 * **##xwiki:annotations:filter:changed##**
148 * **##xwiki:annotations:settings:loaded##**
149
150 == Livetable events (livetable.js) ==
151
152 * **##xwiki:livetable:newrow##** (##event.memo.row## holds the new row)
153 * **##xwiki:livetable:loadingEntries##** (since 2.3 RC1)
154 * **##xwiki:livetable:receivedEntries##** (since 2.3 RC1) (##event.memo.data## contains the received JSON data)
155 * **##xwiki:livetable:loadingComplete##** (since 2.4 M1) (##event.memo.status## contains the response status code)
156 * **##xwiki:livetable:displayComplete##** (since 2.4 M1)
157 * **##xwiki:livetable:ready##** (since 2.4.4)
158 * **##xwiki:livetable:loading##** (since 3.1.1) (should be used in place of ##xwiki:dom:loading## to startup livetables)
159
160 The livetable sends both generic events, named as above, and events specific to each livetable, containing the table name on the third position, such as ##xwiki:livetable:alldocs:loadingEntries##. The generic event has the table name in the memo, as ##event.memo.tableId##.
161
162 = RequireJS and jQuery APIs =
163
164 By default XWiki uses PrototypeJS which is bound to the $ symbol. Starting in XWiki 5.2, you may use jQuery by //requiring// it using the [[RequireJS>>http://requirejs.org/]] AMD standard. To do this you would write your code as follows:
165
166 {{code language="javascript"}}
167 require(['jquery'], function ($) {
168 $('#xwikicontent').append('<p>Inside of this function, $ becomes jquery!</p>');
169 });
170 {{/code}}
171
172 The best part is, any scripts which are loaded using require are loaded //asynchronously// (all at the same time) and if they are not required, they are never loaded at all.
173
174 == Deferred Dependency Loading ==
175
176 Loading (transitive) dependencies through RequireJS works if those modules are known by RequireJS. In order to make a module known you need to tell RequireJS where to load that module from. A module can be located in various places: in a WebJar, in the skin, in a JSX object or even in a file attached to a wiki page. If the module you need is common enough that is loaded on every page (like the 'jquery' module) then chances are it is already known (configured in javascript.vm). Otherwise you need to configure the dependency by using require.config().
177
178 {{code language="js"}}
179 require.config({
180 paths: {
181 module: "path/to/module"
182 },
183 shim: {
184 module: {
185 exports: 'someGlobalVariable',
186 deps: ['anotherModule']
187 }
188 }
189 });
190 {{/code}}
191
192 If two scripts need the same dependency then they will have to duplicate the require configuration. In order to avoid this you could move the configuration in a separate file and write something like this:
193
194 {{code language="js"}}
195 require(['path/to/config'], function() {
196 require(['module'], function(module) {
197 // Do something with the module.
198 });
199 });
200 {{/code}}
201
202 but you would still duplicate the configuration path in both scripts. Now, suppose that one of the scripts is only extending a feature provided by the dependency module. This means that it doesn't necessarily need to bring the dependency. It only needs to extend the module if it's present. This can be achieved starting with XWiki 8.1M1 like this:
203
204 {{code language="js"}}
205 require(['deferred!module'], function(modulePromise) {
206 modulePromise.done(function(module) {
207 // Do something with the module, if the module is loaded by someone else.
208 });
209 });
210 {{/code}}
211
212 In other words, the script says to RequireJS "let me know when this module is loaded by someone else" (someone else being an other script on the same page). This looks similar with the solution where the require configuration is in a separate file, but the advantage is that the path is not duplicated (i.e. we can move the module to a different path without affecting the scripts that use it).
213
214 Examples where this could be useful:
215
216 * extend the tree widget (if it's available on the current page)
217 * extend the WYSIWYG editor (if it's loaded on the current page)
218
219 An alternative is for each module that wants to support extensions to fire some custom events when they are loaded.
220
221 == Bridging custom XWiki events between Prototype and jQuery ==
222
223 Starting with XWiki 6.4 you can catch from jQuery the custom XWiki events that are fired from Prototype.
224
225 {{code language="js"}}
226 require(['jquery', 'xwiki-events-bridge'], function($) {
227 $('.some-element').on('xwiki:moduleName:eventName', function(event, data) {
228 // Here, do something that will be executed at the moment the event is fired.
229 doSomething();
230
231 // The passed data is a reference to the event.memo from Prototype.
232 console.log(data.somethingINeedToKnow);
233 });
234 });
235 {{/code}}
236
237 Starting with XWiki 7.1M1 the event listeners registered from Prototype are notified when a custom XWiki event is fired using the jQuery API. This doesn't mean you should write new event listeners using Prototype but that you can rely on existing event listeners until they are rewritten using jQuery.
238
239 {{code language="js"}}
240 // Prototype (old code that you don't have time to rewrite)
241 document.observe('xwiki:dom:updated', function(event) {
242 event.memo.elements.each(function(element) {
243 // Do something.
244 });
245 });
246 ...
247 // jQuery (new code, in a different file/page)
248 require(['jquery', 'xwiki-events-bridge'], function($) {
249 $(document).trigger('xwiki:dom:updated', {'elements': $('.some-container').toArray()});
250 });
251 {{/code}}
252
253 = Get some information about the current document {{info}}(Since 6.3M2){{/info}} =
254
255 In your javascript's applications, you can get (meta) information about the current document, though an AMD module.
256
257 {{code language="javascript"}}
258 require(['xwiki-meta'], function (xm) {
259 xm.documentReference // since 7.3M2, get the reference of the current document (as a DocumentReference object).
260 xm.document // get the current document (eg: Main.WebHome) -- deprecated since 7.3M2, use documentReference instead
261 xm.wiki // get the current wiki (eg: xwiki) -- deprecated since 7.3M2, use documentReference instead
262 xm.space // get the current space (eg: Main) -- deprecated since 7.3M2, use documentReference instead
263 xm.page // get the current page name (eg: WebHome) -- deprecated since 7.3M2, use documentReference instead
264 xm.version // get the current document version (eg: 1.1)
265 xm.restURL // get the REST url of the current doc (eg: /xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome)
266 xm.form_token // get the current CSRF token that you should pass to your scripts to avoid CSRF attacks.
267 xm.userReference // since 10.4RC1 and 9.11.5, get the reference of the current user
268 xm.isNew // since 11.2RC1, define if the current document is new or not
269 xm.locale // since 12.3RC1, get the locale of the current document
270 });
271 {{/code}}
272
273 {{warning}}
274 It is actually the only clean way. In the past, we used to add some <meta> tags in the <head> section of the page, but is not even valid in HTML5. So now we have introduced this API that we will maintain, meanwhile relying on any other element in the page could be broken in the future!
275 {{/warning}}
276
277 == Be retro-compatible with versions older than 6.3 ==
278
279 If you want to be compatible with older version, you can use this trick:
280
281 {{code language="javascript"}}
282 require(['xwiki-meta'], function (xm) {
283 // Note that the require['xwiki-meta'] (meta information about the current document) is not available on
284 // XWiki versions < 6.3, then we get these meta information directly from the DOM.
285 var document = xm ? xm.document : $('meta[name="document"]').attr('content');
286 var wiki = xm ? xm.wiki : $('meta[name="wiki"]').attr('content');
287 var space = xm ? xm.space : $('meta[name="space"]').attr('content');
288 var page = xm ? xm.wiki : $('meta[name="page"]').attr('content');
289 var version = xm ? xm.version : $('meta[name="version"]').attr('content');
290 var restURL = xm ? xm.restURL : $('meta[name="restURL"]').attr('content');
291 var form_token = xm ? xm.form_token : $('meta[name="form_token"]').attr('content');
292 });
293 {{/code}}
294
295 = Work with Entity References {{info}}(Since 4.2M1){{/info}} =
296
297 You can resolve and serialize Entity References on the client side easily:
298
299 {{code language="js"}}
300 var documentReference = XWiki.Model.resolve('wiki:Space.Page', XWiki.EntityType.DOCUMENT);
301 var attachmentReference = new XWiki.AttachmentReference('logo.png', documentReference);
302 XWiki.Model.serialize(attachmentReference);
303 {{/code}}
304
305 You can check the full API [[here>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-web/src/main/webapp/resources/uicomponents/model/entityReference.js]].
306
307 Starting with XWiki 7.2M1 the ##XWiki.Model## JavaScript API is supporting nested spaces:
308
309 {{code language="js"}}
310 var documentReference = XWiki.Model.resolve('wiki:Path.To.My.Page', XWiki.EntityType.DOCUMENT);
311 documentReference.getReversedReferenceChain().map(function(entityReference) {
312 return entityReference.type + ': ' + entityReference.name
313 }).join()
314 // Will produce:
315 // 0: wiki,1: Path,1: To,1: My,2: Page
316 {{/code}}
317
318 Starting with 7.2M1 you can also pass a 'provider' as the third argument to ##XWiki.Model.resolve()##. The provider is used to fill missing references, and it is either a function that gets the entity type, an array of entity names or an entity reference.
319
320 {{code language="js"}}
321 var documentReference = XWiki.Model.resolve('Page', XWiki.EntityType.DOCUMENT, function(type) {
322 switch(type) {
323 case: XWiki.EntityType.WIKI:
324 return 'wiki';
325 case: XWiki.EntityType.SPACE:
326 return 'Space';
327 default:
328 return null;
329 }
330 });
331 // Produces wiki:Space.Page
332
333 var documentReference = XWiki.Model.resolve('Page', XWiki.EntityType.DOCUMENT, ['wiki', 'Space']);
334 // Same output
335
336 var spaceReference = new XWiki.SpaceReference('wiki', 'Space');
337 var documentReference = XWiki.Model.resolve('Page', XWiki.EntityType.DOCUMENT, spaceReference);
338 // Same output
339 {{/code}}
340
341 Starting with 7.2M2 you can construct Reference to Nested Spaces and a new ##equals()## method has been added. Examples using Jasmine:
342
343 {{code language="js"}}
344 // Construct a Nested Space reference
345 var reference = new XWiki.SpaceReference('wiki', ['space1', 'space2']);
346 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space1.space2');
347 reference = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
348 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space1.space2.page');
349 // Construct a non-Nested Space reference
350 reference = new XWiki.SpaceReference('wiki', 'space');
351 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space');
352 // Try passing non-valid space parameters
353 expect(function() {new XWiki.SpaceReference('wiki', [])}).toThrow('Missing mandatory space name or invalid type for: []');
354 expect(function() {new XWiki.SpaceReference('wiki', 12)}).toThrow('Missing mandatory space name or invalid type for: [12]');
355
356 // Equals() examples
357 var reference1 = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
358 var reference2 = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
359 var reference3 = new XWiki.DocumentReference('wiki2', ['space1', 'space2'], 'page');
360 expect(reference1.equals(reference2)).toBe(true);
361 expect(reference1.equals(reference3)).toBe(false);
362 {{/code}}
363
364 In 7.2M2 a new XWiki.EntityReferenceTree class which partially mimic Java EntityReferenceTree on Javascript side. There is not much yet, it was mostly introduced to make easier to manipulate a serialized Java EntityReferenceTree.
365
366 {{code}}
367 this.entities = XWiki.EntityReferenceTree.fromJSONObject(transport.responseText.evalJSON());
368 {{/code}}
369 )))
370
371 = Related =
372
373 {{velocity}}
374 #set($tag = 'javascript')
375 #set ($list = $xwiki.tag.getDocumentsWithTag($tag))
376 (((
377 (% class="xapp" %)
378 == $services.localization.render('xe.tag.alldocs', ["//${tag}//"]) ==
379
380 #if ($list.size()> 0)
381 {{html}}#displayDocumentList($list false $blacklistedSpaces){{/html}}
382 #else
383 (% class='noitems' %)$services.localization.render('xe.tag.notags')
384 #end
385 )))
386 {{/velocity}}
387
388 = Example of understanding initialization =
389
390 {{warning}}
391 Please note that the following example is very specific:
392
393 * It applies to old JavaScript code written using Prototype.js. The more recent recommendation is to use RequireJS and JQuery.
394 * It doesn't apply fully to any page having a LiveTable because the Rights UI has custom code to load the LiveTable.
395 {{/warning}}
396
397 Let's take the example of the Rights page of the Admin UI and understand how its LiveTable is initialized.
398
399 The browser will read the HTML from top to bottom. We have the following HTML content:
400
401 {{code language="html"}}
402 ...
403 <head>
404 ...
405 <script type='text/javascript' src='/xwiki/resources/js/prototype/prototype.js?cache-version=1584467090000'></script>
406 ...
407 <script type='text/javascript' src='/xwiki/bin/skin/resources/js/xwiki/xwiki.js?cache-version=1584467090000&defer=false&amp;minify=false'></script>
408 ...
409 <script type='text/javascript' src='/xwiki/bin/skin/resources/js/xwiki/table/livetable.js?cache-version=1584467090000&minify=false' defer='defer'></script>
410 ...
411 </head>
412 <body>
413 ...
414 function startup() {
415 ... Rights LT init...
416 }
417 ...
418 (XWiki && XWiki.isInitialized && startup()) || document.observe('xwiki:livetable:loading', startup);
419 ...
420 {{/code}}
421
422 So here are the steps performed:
423
424 1. ##prototype.js## is executed first and registers a function (~{~{code}document.addEventListener('DOMContentLoaded', fireContentLoadedEvent, false);~{~{/code}}) to execute when the ##DOMContentLoaded## event is sent. This event is sent after the DOM has been parsed, thus after the scripts of the page have been executed. The ##fireContentLoadedEvent## function will fire the [[##dom:loaded## event>>http://api.prototypejs.org/dom/document/observe/]] when called.
425 1. ##xwiki.js## is executed and registers a function ({{code}}document.observe("dom:loaded", XWiki.initialize.bind(XWiki)){{/code}}) to execute when the ##dom:loaded## event is sent. In turn it'll fire 2 events ##xwiki:dom:loading## and ##xwiki:dom:loaded## when called.
426 1. ##livetable.js## is not executed at this stage since it's marked as ##defer##.
427 1. The Rights UI is executed and {{code}}XWiki && XWiki.isInitialized && startup(){{/code}} evaluates to false since the XWiki object has not been initialized yet at this stage. However it registers a function for the ##xwiki:livetable:loading## event.
428 1. The browser gets to the end of the HTML, and [[reads the ##livetable.js## script that was marked as deferred>>https://javascript.info/onload-ondomcontentloaded#domcontentloaded]]. The following executes: {{code}}(XWiki.isInitialized && init()) || document.observe('xwiki:dom:loading', init);{{/code}}. The {{code}}XWiki && XWiki.isInitialized && startup(){{/code}} part evaluates to false since the XWiki object has not been initialized yet. The ##init## function is registered for the ##xwiki:dom:loading## event. When fired, it will trigger the ##xwiki:livetable:loading## event.
429 1. Now that the DOM has been read, the browser sends the ##DOMContentLoaded## event.
430 1. Thus the prototype function is called and the ##dom:loaded## event is triggered.
431 1. Thus the ##xwiki.js##'s ##initialize## function is called and the ##xwiki:dom:loading## event is fired.
432 1. Thus the ##livetable.js##'s ##init## function is called and the ##xwiki:livetable:loading## event is fired.
433 1. Thus the Rights UI's ##startup## function is called and its LiveTable is initialized.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected