Wiki source code of XWiki UI Standards

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 Welcome! These pages are a shared guide to building the XWiki interface. Following them helps XWiki and its extensions feel like one product: users find things where they expect them, and every screen works the same way, with a mouse, a keyboard or a screen reader.
6
7 They are written for everyone who builds UI for XWiki: platform developers, extension developers and designers.
8
9 (% class="ui-standards-cards" style="display: flex; flex-wrap: wrap; gap: 16px; margin: 16px 0 32px;" %)
10 (((
11 (% class="panel panel-default" style="flex: 1 1 220px; margin: 0; display: flex; flex-direction: column;" %)
12 (((
13 (% class="panel-body" style="flex: 1;" %)
14 (((
15 (% class="text-primary" style="font-size: 2em; line-height: 1; margin-bottom: 12px;" aria-hidden="true" %)
16 (((
17 {{displayIcon name="desktop"/}}
18 )))
19
20 (% style="margin-top: 0; font-size: 1.4em;" %)
21 == [[Interface Overview>>doc:UserExperience.UIStandards.InterfaceOverview.WebHome]] ==
22
23 The regions of every page, and where to add your own features.
24 * [[The regions>>doc:UserExperience.UIStandards.InterfaceOverview.WebHome||anchor="HTheregions"]]
25 * [[Adding to the interface>>doc:UserExperience.UIStandards.InterfaceOverview.WebHome||anchor="HAddingtotheinterface"]]
26 )))
27 )))
28 (% class="panel panel-default" style="flex: 1 1 220px; margin: 0; display: flex; flex-direction: column;" %)
29 (((
30 (% class="panel-body" style="flex: 1;" %)
31 (((
32 (% class="text-primary" style="font-size: 2em; line-height: 1; margin-bottom: 12px;" aria-hidden="true" %)
33 (((
34 {{displayIcon name="bricks"/}}
35 )))
36
37 (% style="margin-top: 0; font-size: 1.4em;" %)
38 == [[Components>>doc:UserExperience.UIStandards.Components.WebHome]] ==
39
40 The building blocks every screen is made of.
41 * [[Buttons>>doc:UserExperience.UIStandards.Components.Buttons.WebHome]]
42 * [[Forms and inputs>>doc:UserExperience.UIStandards.Components.FormsAndInputs.WebHome]]
43 * [[Modal>>doc:UserExperience.UIStandards.Components.Modal.WebHome]]
44 * [[Menus and dropdowns>>doc:UserExperience.UIStandards.Components.MenusAndDropdowns.WebHome]]
45 * [[LiveData table>>doc:UserExperience.UIStandards.Components.LiveDataTable.WebHome]]
46 * [[Alerts and notifications>>doc:UserExperience.UIStandards.Components.AlertsAndNotifications.WebHome]]
47 )))
48 )))
49 (% class="panel panel-default" style="flex: 1 1 220px; margin: 0; display: flex; flex-direction: column;" %)
50 (((
51 (% class="panel-body" style="flex: 1;" %)
52 (((
53 (% class="text-primary" style="font-size: 2em; line-height: 1; margin-bottom: 12px;" aria-hidden="true" %)
54 (((
55 {{displayIcon name="shape_group"/}}
56 )))
57
58 (% style="margin-top: 0; font-size: 1.4em;" %)
59 == [[Patterns>>doc:UserExperience.UIStandards.Patterns.WebHome]] ==
60
61 Flows for situations that come up again and again.
62 * [[Delete confirmation>>doc:UserExperience.UIStandards.Patterns.DeleteConfirmation.WebHome]]
63 * [[Empty state>>doc:UserExperience.UIStandards.Patterns.EmptyState.WebHome]]
64 )))
65 )))
66 (% class="panel panel-default" style="flex: 1 1 220px; margin: 0; display: flex; flex-direction: column;" %)
67 (((
68 (% class="panel-body" style="flex: 1;" %)
69 (((
70 (% class="text-primary" style="font-size: 2em; line-height: 1; margin-bottom: 12px;" aria-hidden="true" %)
71 (((
72 {{displayIcon name="font"/}}
73 )))
74
75 (% style="margin-top: 0; font-size: 1.4em;" %)
76 == [[Content>>doc:UserExperience.UIStandards.Content.WebHome]] ==
77
78 The words in the interface: labels and messages.
79 * [[Action labels>>doc:UserExperience.UIStandards.Content.ActionLabels.WebHome]]
80 )))
81 )))
82 )))
83
84 = How to read an entry =
85
86 Every entry starts short. First comes the standard to follow, then a reference example: a place in XWiki that already does it right, which you can open, look at and use as a model. Notes and links to related entries come last, for when you need more detail.
87
88 = Where to start =
89
90 * **New to the XWiki interface?** Start with [[Interface Overview>>doc:UserExperience.UIStandards.InterfaceOverview.WebHome]], a short tour of the page regions and of where to add your own features.
91 * **Building a screen?** Check the components it uses, then go through [[Accessibility>>doc:UserExperience.UIStandards.Accessibility.WebHome]] before you ship it.
92 * **Writing labels or messages?** See [[Action labels>>doc:UserExperience.UIStandards.Content.ActionLabels.WebHome]] and [[Alerts and notifications>>doc:UserExperience.UIStandards.Components.AlertsAndNotifications.WebHome]].
93
94 = Accessibility =
95
96 * [[Accessibility>>doc:UserExperience.UIStandards.Accessibility.WebHome]]: the level XWiki aims for, what to check by hand and how to test
97
98 = Look and feel =
99
100 Colors, typography and spacing come from the color theme, so they should never be hardcoded. Iceberg, the default theme, is the reference.
101
102 = Something missing? =
103
104 These standards grow with XWiki. If a standard is missing, or doesn't fit your case, share it on the [[XWiki forum>>https://forum.xwiki.org/]] so that it can be discussed.

Get Connected