User Interface
This section documents the UI components and patterns used in UpDoc, categorised by their origin:
- UUI Components — Native Umbraco UI Library primitives (
uui-*elements) - Umbraco Components — Higher-level Umbraco backoffice components (
umb-*elements) - Custom Components — Components built specifically for UpDoc (
up-doc-*elements)
Design Principles
Section titled “Design Principles”UpDoc follows the Umbraco backoffice design language wherever possible. When building UI:
- Use native UUI/Umbraco components first — only create custom components when no native equivalent exists
- Follow established patterns — look at how Umbraco core and popular packages (uSync, Merchello) solve similar problems
- Consistent visual language — stat boxes, tab groups, tables, and layouts should match what users see elsewhere in the backoffice
- UUI CSS custom properties — all colours, spacing, and typography use
--uui-*tokens, never hardcoded values
References
Section titled “References”- UUI Storybook — base UI primitives (
uui-button,uui-box,uui-tab, etc.) - Umbraco API Docs Storybook — composed Umbraco components, layout patterns, property editors
- Umbraco CMS Source — definitive reference for how components are used in practice
Gaps and Feedback
Section titled “Gaps and Feedback”Where UpDoc has needed to work around limitations or build custom solutions, these are noted on the relevant component pages. This information is intended as constructive feedback for the Umbraco core team.