Skip to Content

Wiki source code of XWiki JavaScript API

Version 39.1 by Ecaterina Moraru (Valica) on 2017/09/01
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 * **##xwiki:dom:loaded##**
26 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:(((
27 {{code language="javascript"}}
28 document.observe("xwiki:dom:loaded", function(){
29 // Initialization that can rely on the fact the DOM is XWiki-tranformed goes here.
30 });
31 {{/code}}
32 )))(((
33 {{info}}
34 It is recommended to bind startup scripts to this event instead of ##window.load## or ##document.dom:loaded##.
35 {{/info}}
36 )))
37
38 * **##xwiki:dom:loading##**
39 ##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.
40 * **##xwiki:dom:updated##**
41 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:(((
42 {{code language="javascript"}}
43 var init = function(elements) {
44 // Search for special content to enhance in each DOM element in the "elements" list and enhance it
45 elements.each(function(element) {
46 element.select('.someBehavioralClass').each(function(item) {
47 enhance(item);
48 });
49 });
50 }
51 ['xwiki:dom:loaded', 'xwiki:dom:updated'].each(function(eventName) {
52 document.observe(eventName, function(event) {
53 init(event.memo && event.memo.elements || [document.documentElement]);
54 });
55 });
56 {{/code}}
57
58 {{warning}}
59 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:(((
60 {{code}}
61 function init() {
62 // This is your initialization handler, that you generally hook to xwiki:dom:loaded
63 }
64 (XWiki && XWiki.domIsLoaded && init()) || document.observe("xwiki:dom:loaded", init);
65 {{/code}})))
66 {{/warning}}
67
68 == Document content events (actionButtons.js) ==
69
70 * **##xwiki:document:saved##**
71 This event is sent after the document has been successfully saved in an asynchronous request (i.e. after clicking the //Save and Continue// button).
72 * **##xwiki:document:saveFailed##**
73 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##.
74
75 == Action events (actionButtons.js) ==
76
77 * **##xwiki:actions:cancel##**
78 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.
79 * **##xwiki:actions:beforePreview##** (7.4.1+, 8.0M1+)
80 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.
81 * **##xwiki:actions:preview##**
82 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.
83 * **##xwiki:actions:beforeSave##** (7.4.1+, 8.0M1+)
84 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.
85 * **##xwiki:actions:save##**
86 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:(((
87 {{code language="javascript"}}
88 document.observe("xwiki:actions:save", function(event){
89 var doContinue = event.memo['continue'];
90 if (doContinue) {
91 // do something specific
92 }
93 });
94 {{/code}}
95 )))(((
96 {{warning}}
97 While most properties can be accessed as ##event.memo.property##, this doesn't work with ##event.memo.continue## since ##continue## is a reserved keyword.
98 {{/warning}}
99 )))(((
100 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.
101 )))
102
103 == Document extra events (xwiki.js) ==
104
105 * **##xwiki:docextra:loaded##**
106 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.(((
107 {{code language="javascript"}}
108 document.observe("xwiki:docextra:loaded", function(event){
109 var tabID = event.memo.id;
110 if (tabID == "attachments") {
111 // do something with the attachments tab retrieved content.
112 doSomething(event.memo.element);
113 }
114 });
115 {{/code}}
116 )))
117 * **##xwiki:docextra:activated##**
118 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##
119
120 == WYSIWYG events (XWikiWysiwyg.js) ==
121
122 WYSIWYG has it's own custom [[events list>>extensions:Extension.WYSIWYG Editor Module||anchor="HCustomevents"]].
123
124 == Suggest events (ajaxSuggest.js) ==
125
126 * **##xwiki:suggest:selected##** (since 2.3)
127 This event is fired on the target input when a value was selected.
128
129 == Fullscreen events (fullScreenEdit.js) ==
130
131 * **##xwiki:fullscreen:enter##** (since 3.0 M3) (fired before entering full screen editing)
132 * **##xwiki:fullscreen:entered##** (since 2.5.1) (fired after entering full screen editing)
133 * **##xwiki:fullscreen:exit##** (since 3.0 M3) (fired before exiting full screen editing)
134 * **##xwiki:fullscreen:exited##** (since 2.5.1) (fired after exiting full screen editing)
135 * **##xwiki:fullscreen:resized##** (since 2.5.1)
136
137 All events have the target DOM element in ##event.memo.target##.
138
139 == Annotations events (AnnotationCode/Settings jsx) ==
140
141 * **##xwiki:annotations:filter:changed##**
142 * **##xwiki:annotations:settings:loaded##**
143
144 == Livetable events (livetable.js) ==
145
146 * **##xwiki:livetable:newrow##** (##event.memo.row## holds the new row)
147 * **##xwiki:livetable:loadingEntries##** (since 2.3 RC1)
148 * **##xwiki:livetable:receivedEntries##** (since 2.3 RC1) (##event.memo.data## contains the received JSON data)
149 * **##xwiki:livetable:loadingComplete##** (since 2.4 M1) (##event.memo.status## contains the response status code)
150 * **##xwiki:livetable:displayComplete##** (since 2.4 M1)
151 * **##xwiki:livetable:ready##** (since 2.4.4)
152 * **##xwiki:livetable:loading##** (since 3.1.1) (should be used in place of ##xwiki:dom:loading## to startup livetables)
153
154 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##.
155
156 = RequireJS and jQuery APIs =
157
158 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:
159
160 {{code language="javascript"}}
161 require(['jquery'], function ($) {
162 $('#xwikicontent').append('<p>Inside of this function, $ becomes jquery!</p>');
163 });
164 {{/code}}
165
166 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.
167
168 == Deferred Dependency Loading ==
169
170 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().
171
172 {{code language="js"}}
173 require.config({
174 paths: {
175 module: "path/to/module"
176 },
177 shim: {
178 module: {
179 exports: 'someGlobalVariable',
180 deps: ['anotherModule']
181 }
182 }
183 });
184 {{/code}}
185
186 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:
187
188 {{code language="js"}}
189 require(['path/to/config'], function() {
190 require(['module'], function(module) {
191 // Do something with the module.
192 });
193 });
194 {{/code}}
195
196 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:
197
198 {{code language="js"}}
199 require(['deferred!module'], function(modulePromise) {
200 modulePromise.done(function(module) {
201 // Do something with the module, if the module is loaded by someone else.
202 });
203 });
204 {{/code}}
205
206 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).
207
208 Examples where this could be useful:
209
210 * extend the tree widget (if it's available on the current page)
211 * extend the WYSIWYG editor (if it's loaded on the current page)
212
213 An alternative is for each module that wants to support extensions to fire some custom events when they are loaded.
214
215 == Bridging custom XWiki events between Prototype and jQuery ==
216
217 Starting with XWiki 6.4 you can catch from jQuery the custom XWiki events that are fired from Prototype.
218
219 {{code language="js"}}
220 require(['jquery', 'xwiki-events-bridge'], function($) {
221 $('.some-element').on('xwiki:moduleName:eventName', function(event, data) {
222 // Here, do something that will be executed at the moment the event is fired.
223 doSomething();
224
225 // The passed data is a reference to the event.memo from Prototype.
226 console.log(data.somethingINeedToKnow);
227 });
228 });
229 {{/code}}
230
231 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.
232
233 {{code language="js"}}
234 // Prototype (old code that you don't have time to rewrite)
235 document.observe('xwiki:dom:updated', function(event) {
236 event.memo.elements.each(function(element) {
237 // Do something.
238 });
239 });
240 ...
241 // jQuery (new code, in a different file/page)
242 require(['jquery', 'xwiki-events-bridge'], function($) {
243 $(document).trigger('xwiki:dom:updated', {'elements': $('.some-container').toArray()});
244 });
245 {{/code}}
246
247 = Get some information about the current document {{info}}(Since 6.3M2){{/info}} =
248
249 In your javascript's applications, you can get (meta) information about the current document, though an AMD module.
250
251 {{code language="javascript"}}
252 require(['xwiki-meta'], function (xm) {
253 xm.documentReference // since 7.3M2, get the reference of the current document (as a DocumentReference object).
254 xm.document // get the current document (eg: Main.WebHome) -- deprecated since 7.3M2, use documentReference instead
255 xm.wiki // get the current wiki (eg: xwiki) -- deprecated since 7.3M2, use documentReference instead
256 xm.space // get the current space (eg: Main) -- deprecated since 7.3M2, use documentReference instead
257 xm.page // get the current page name (eg: WebHome) -- deprecated since 7.3M2, use documentReference instead
258 xm.version // get the current document version (eg: 1.1)
259 xm.restURL // get the REST url of the current doc (eg: /xwiki/rest/wikis/xwiki/spaces/Main/pages/WebHome)
260 xm.form_token // get the current CSRF token that you should pass to your scripts to avoid CSRF attacks.
261 });
262 {{/code}}
263
264 {{warning}}
265 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!
266 {{/warning}}
267
268 == Be retro-compatible with versions older than 6.3 ==
269
270 If you want to be compatible with older version, you can use this trick:
271
272 {{code language="javascript"}}
273 require(['xwiki-meta'], function (xm) {
274 // Note that the require['xwiki-meta'] (meta information about the current document) is not available on
275 // XWiki versions < 6.3, then we get these meta information directly from the DOM.
276 var document = xm ? xm.document : $('meta[name="document"]').attr('content');
277 var wiki = xm ? xm.wiki : $('meta[name="wiki"]').attr('content');
278 var space = xm ? xm.space : $('meta[name="space"]').attr('content');
279 var page = xm ? xm.wiki : $('meta[name="page"]').attr('content');
280 var version = xm ? xm.version : $('meta[name="version"]').attr('content');
281 var restURL = xm ? xm.restURL : $('meta[name="restURL"]').attr('content');
282 var form_token = xm ? xm.form_token : $('meta[name="form_token"]').attr('content');
283 });
284 {{/code}}
285
286 = Work with Entity References {{info}}(Since 4.2M1){{/info}} =
287
288 You can resolve and serialize Entity References on the client side easily:
289
290 {{code language="js"}}
291 var documentReference = XWiki.Model.resolve('wiki:Space.Page', XWiki.EntityType.DOCUMENT);
292 var attachmentReference = new XWiki.AttachmentReference('logo.png', documentReference);
293 XWiki.Model.serialize(attachmentReference);
294 {{/code}}
295
296 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]].
297
298 Starting with XWiki 7.2M1 the ##XWiki.Model## JavaScript API is supporting nested spaces:
299
300 {{code language="js"}}
301 var documentReference = XWiki.Model.resolve('wiki:Path.To.My.Page', XWiki.EntityType.DOCUMENT);
302 documentReference.getReversedReferenceChain().map(function(entityReference) {
303 return entityReference.type + ': ' + entityReference.name
304 }).join()
305 // Will produce:
306 // 0: wiki,1: Path,1: To,1: My,2: Page
307 {{/code}}
308
309 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.
310
311 {{code language="js"}}
312 var documentReference = XWiki.Model.resolve('Page', XWiki.EntityType.DOCUMENT, function(type) {
313 switch(type) {
314 case: XWiki.EntityType.WIKI:
315 return 'wiki';
316 case: XWiki.EntityType.SPACE:
317 return 'Space';
318 default:
319 return null;
320 }
321 });
322 // Produces wiki:Space.Page
323
324 var documentReference = XWiki.Model.resolve('Page', XWiki.EntityType.DOCUMENT, ['wiki', 'Space']);
325 // Same output
326
327 var spaceReference = new XWiki.SpaceReference('wiki', 'Space');
328 var documentReference = XWiki.Model.resolve('Page', XWiki.EntityType.DOCUMENT, spaceReference);
329 // Same output
330 {{/code}}
331
332 Starting with 7.2M2 you can construct Reference to Nested Spaces and a new ##equals()## method has been added. Examples using Jasmine:
333
334 {{code language="js"}}
335 // Construct a Nested Space reference
336 var reference = new XWiki.SpaceReference('wiki', ['space1', 'space2']);
337 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space1.space2');
338 reference = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
339 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space1.space2.page');
340 // Construct a non-Nested Space reference
341 reference = new XWiki.SpaceReference('wiki', 'space');
342 expect(XWiki.Model.serialize(reference)).toEqual('wiki:space');
343 // Try passing non-valid space parameters
344 expect(function() {new XWiki.SpaceReference('wiki', [])}).toThrow('Missing mandatory space name or invalid type for: []');
345 expect(function() {new XWiki.SpaceReference('wiki', 12)}).toThrow('Missing mandatory space name or invalid type for: [12]');
346
347 // Equals() examples
348 var reference1 = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
349 var reference2 = new XWiki.DocumentReference('wiki', ['space1', 'space2'], 'page');
350 var reference3 = new XWiki.DocumentReference('wiki2', ['space1', 'space2'], 'page');
351 expect(reference1.equals(reference2)).toBe(true);
352 expect(reference1.equals(reference3)).toBe(false);
353 {{/code}}
354
355 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.
356
357 {{code}}
358 this.entities = XWiki.EntityReferenceTree.fromJSONObject(transport.responseText.evalJSON());
359 {{/code}}
360 )))

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected