Skip to content

UI style guide

David Díaz edited this page May 11, 2023 · 4 revisions

The Agama UI does not have a defined style guide yet. That's because the project is at an early stage and we are learning and setting the foundations along the way.

Let this document serve as a living draft to write down patterns, considerations, and agreements that emerge as the project develops and more information and feedback are gathered. With a bit of luck and a lot of work it will help us have, in the long run, a solid, well-defined style guide.

Since the ultimate goal is a light, intuitive, and self-explanatory interface, we should embrace re-evaluations and changes as long as they translate into improvements for the interface and its users.


  • Use CUBE CSS methodology

    We are not there yet, but the idea is to follow it.

  • When possible, use PatternFly as component library

    But not for laying out components, unless we find https://github.com/openSUSE/agama/pull/391 became no longer relevant or does not pay off.

  • When writing a component, have a look at ARIA Authoring Practices Guide, specially the Patterns section to see if there is something applicable

  • Avoid collisions with underlying technologies or tools when naming a component unless it is just a wrapper.

    I.e., do not name it Details (HTML has the <details> disclosure element) or Tooltip (PatternFly already provides one)

Clone this wiki locally