-
Notifications
You must be signed in to change notification settings - Fork 42
UI style guide
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.
-
When possible, use PatternFly as component library
-
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) orTooltip
(PatternFly already provides one)