This project provides a central "UI Kit" accessible at `/ui-kit` that showcases the visual appearance and behavior of all site elements and components. It helps teams ensure visual consistency and allows for easy management and sharing of design elements, with newer versions adding support for a story-based component browsing system and optional integration for assigning components to fields without code.
The UI Kit gives your team a single, reliable place to see exactly how every element on your site looks and behaves — all available at /ui-kit.
What's included in version 1
- Minimal setup — works with your existing theme straight out of the box.
- Control the look of the UI Kit itself using CSS variables.
- Manage glossary sections directly through the UI — add, remove, or reorder without touching code.
- Custom sections are picked up automatically.
- Link directly to any section and copy the URL to share with your team.
- Automatic colour contrast checking built in.
- Full support for Bootstrap Icons and SVG sprites.
What's new in version 2
- Browse and preview components through a simple, story-based system.
- Works across single projects and monorepos — components are discovered automatically.
- Consistent component previews with support for multiple variants and overrides.
- Icon search on the iconography page.
- Lightweight and easy to tailor to your project.
Single Directory Components (SDC) support
Version 2 optionally integrates with SDC Display, allowing site builders to assign components to fields, field groups, or view modes directly through the backend UI — no template editing required. The quickest way to get started is by using the Bootstrap Components module (a lightweight port of the ui_suite_bootstrap SDC components).