Wiki source code of Interface Overview

Last modified by Thiago Krieck on 2026/11/18 14:13

Show last authors
1 {{warning title="Draft"}}
2 This page is a draft. The standards on it are proposals still under discussion, so they may change and should not be treated as final yet.
3 {{/warning}}
4
5 Every XWiki page is built from the same set of regions, and each region has one job. Getting to know them is the best first step: users always know where to look, and you always know where your feature belongs.
6
7 [[The regions of a page in view mode: the wiki home page>>image:io-reference-view-page.png||style="max-width: min(1600px, 100%); height: auto;"]]
8
9 = The regions =
10
11 Every page should use the same regions for the same purpose:
12
13 * **Top bar:** Should hold only what every page needs: the logo, search, notifications, the user menu and the button that opens the drawer. Page-specific actions should not go here.
14 * **Drawer:** Should hold wiki-wide navigation and tools, such as Administration, the applications, the page and user indexes and the language picker, grouped under the current wiki and //Global//.
15 * **Breadcrumbs:** Should show where the page sits in the hierarchy, and nothing else.
16 * **Title and content menu:** Should show the page title and its last change on the left, and the page actions (//Edit//, //Create//, //More actions//) on the right, never inside the content, so that actions are always found in one place. See [[Menus and dropdowns>>doc:UserExperience.UIStandards.Components.MenusAndDropdowns.WebHome]].
17 * **Content:** Should hold the page itself, or the application sheet that displays it.
18 * **Panels:** Should hold supporting content only, such as navigation on the left and tips or recent changes on the right. Nothing essential should live only in a panel, since panels can be hidden and move below the content on small screens.
19 * **Content footer:** Should hold short page metadata, such as tags, authors and likes.
20 * **Docextra tabs:** Should hold what is attached to the page: comments, annotations, attachments, history and information.
21 * **Footer:** Should hold the license and the version only.
22 * **Edit mode:** Should keep the top bar and breadcrumbs, show the editor in the content region and keep the save actions in the sticky bar at the bottom, so that users don't lose their bearings while editing. See [[Buttons>>doc:UserExperience.UIStandards.Components.Buttons.WebHome]].
23 * **Administration:** Should use the view layout, with the administration menu on the left of the content. New sections should be added with a ##{{{XWiki.ConfigurableClass}}}## object, not a UIX.
24
25 Reference example: any page in view mode, such as the wiki home page. Each region is a labelled landmark, a skip link jumps straight to the content, and most regions can be extended through a UIX point.
26
27 = Adding to the interface =
28
29 Most regions can be extended without touching the skin. Each one has a UI extension point (UIX): a named spot that an extension fills by adding a ##{{{XWiki.UIExtensionClass}}}## object to a page, with the point's id in its ##{{{extensionPointId}}}## field. To add something to a region, developers should use its UIX point rather than override a template, so that their addition keeps working when the skin changes. To learn how to write one, see the [[UI Extension Tutorial>>xwiki:Documentation.DevGuide.Tutorials.UIXTutorial.WebHome]]; [[Available Extension Points>>xwiki:Documentation.DevGuide.ExtensionPoint.WebHome]] lists every point, not only the main ones below.
30
31 The images below show where the main points render. The numbers match the table.
32
33 (% style="display: flex; flex-wrap: wrap; gap: 24px; align-items: flex-start;" %)
34 (((
35 [[UIX points on a page, with the Edit and More actions menus open>>image:io-uix-page.png||style="max-width: 1000px; height: auto;"]]
36
37 [[UIX points in the drawer>>image:io-uix-drawer.png||style="max-width: 280px; height: auto;"]]
38 )))
39
40 |=#|=To add|=UIX point
41 |1|A global item in the top bar, such as search, notifications or the user menu|##{{{org.xwiki.platform.topmenu.right}}}##
42 |2|A drawer entry, under the current wiki (##{{{category}}}## = ##{{{local}}}##) or under //Global// (##{{{category}}}## = ##{{{global}}}##)|##{{{org.xwiki.plaftorm.drawer}}}##
43 |3|An editor in the //Edit// menu|##{{{org.xwiki.plaftorm.editactions}}}##
44 |4|A page action in //More actions// → //Manage//|##{{{org.xwiki.plaftorm.adminactions}}}##
45 |5|A page action in //More actions// → //Actions//|##{{{org.xwiki.plaftorm.moreoptions}}}##
46 |6|A way of viewing the page in //More actions// → //Viewers//|##{{{org.xwiki.platform.template.menu.viewers}}}##
47 |7|Content between the page header and the content, such as a banner|##{{{org.xwiki.platform.template.content.header.after}}}##
48 |8|An item in the content footer|##{{{org.xwiki.platform.template.contentFooter}}}##
49 |9|A docextra tab|##{{{org.xwiki.plaftorm.template.docextra}}}##
50 |10|An entry in the Applications panel|##{{{org.xwiki.platform.panels.Applications}}}##
51 |11|A panel|a page with a ##{{{Panels.PanelClass}}}## object (##{{{platform.panels}}}##), not a UIX
52 |–|Scripts or other code that doesn't show anything|##{{{org.xwiki.platform.template.header.after}}}##
53
54 = Notes =
55
56 * Several UIX point ids are spelled ##{{{plaftorm}}}##. They are public API, so they should be copied exactly, not corrected.
57 * Most top bar, drawer and content menu UIX points are only rendered when their author has admin rights on the wiki.
58 * The //Edit// menu (3) only appears for advanced users; simple users get a single //Edit// button that opens the default editor.
59 * Below 992px the panels stack under the content and the page header stacks title over actions. Each region should be checked at that width.
60
61 = More =
62
63 * Next: [[XWiki UI Standards>>doc:UserExperience.UIStandards.WebHome]] lists every component and pattern
64 * Documentation on xwiki.org: [[UI Extension Tutorial>>xwiki:Documentation.DevGuide.Tutorials.UIXTutorial.WebHome]], [[Available Extension Points>>xwiki:Documentation.DevGuide.ExtensionPoint.WebHome]]
65 * Related: [[Menus and dropdowns>>doc:UserExperience.UIStandards.Components.MenusAndDropdowns.WebHome]], [[Buttons>>doc:UserExperience.UIStandards.Components.Buttons.WebHome]], [[Accessibility>>doc:UserExperience.UIStandards.Accessibility.WebHome]]

Get Connected