XWiki UI Standards
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.
They are written for everyone who builds UI for XWiki: platform developers, extension developers and designers.
Interface Overview
The regions of every page, and where to add your own features.
Components
The building blocks every screen is made of.
How to read an entry
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.
Where to start
- New to the XWiki interface? Start with Interface Overview, a short tour of the page regions and of where to add your own features.
- Building a screen? Check the components it uses, then go through Accessibility before you ship it.
- Writing labels or messages? See Action labels and Alerts and notifications.
Accessibility
- Accessibility: the level XWiki aims for, what to check by hand and how to test
Look and feel
Colors, typography and spacing come from the color theme, so they should never be hardcoded. Iceberg, the default theme, is the reference.
Something missing?
These standards grow with XWiki. If a standard is missing, or doesn't fit your case, share it on the XWiki forum so that it can be discussed.