-
Notifications
You must be signed in to change notification settings - Fork 214
docs: rewrite button syling docs to mention Aura #4855
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
web-padawan
commented
Dec 1, 2025
- Moved "Style variants" examples from the Button page to Styling tab
- Updated custom CSS properties tables to mention Lumo / Aura support
- Created a table to list variants Lumo / Aura support & Aura selectors
rolfsmeds
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably rework the variants docs at some point to be a bit more compact, but that needs a lot of thinking and can be left for later. Good enough for now, let's just change the caption of the selector column.
Co-authored-by: Rolf Smeds <rolf@vaadin.com>
80b4fd0 to
9d58307
Compare
|
|
||
| [cols="1,3,1"] | ||
| |=== | ||
| | Variant | CSS selector | Supported by |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For Button this table structure makes sense, and it's mostly obvious what the individual variants do. However for other components it would be very valuable to have a description on what a variant does, especially since Aura specific theme variants don't have separate section / example.
Also the selector column makes less sense for other components, since variants there probably always use the theme attribute. Or are there other components where you use a class name?
So maybe we should rather have a description column, and then specifically for Button have some additional paragraph that Aura requires applying class names for success / warning / error instead of the theme attribute?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, thanks. Added the "description" column with the usage recommendation (text mostly copied from below with some slight adjustments) and a "note" admonition regarding Aura CSS class names.
| |Success | ||
| |Recommended as an additional color option | ||
| |Lumo, Aura | ||
|
|
||
| |Error | ||
| |Recommended for dangerous or irreversible actions | ||
| |Lumo, Aura | ||
|
|
||
| |Warning | ||
| |Recommended for actions related to warnings | ||
| |Lumo, Aura |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Could unify the order in which Aura and Lumo are listed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, done.
AI Language ReviewThe updated documentation consolidates information well but has removed sections that provided a more comprehensive understanding of button styles and their usage. Below are some issues and suggestions:
By addressing these points, you can enhance the clarity and usefulness of the Button documentation for users, ensuring it provides both comprehensive information and quick, accessible insights. |
The comment has been addressed and the variants table is updated.