docs(button-group): add docs around role="group" and role="toolbar"#2842
Open
adamjohnson wants to merge 3 commits intostaging/eeveefrom
Open
docs(button-group): add docs around role="group" and role="toolbar"#2842adamjohnson wants to merge 3 commits intostaging/eeveefrom
role="group" and role="toolbar"#2842adamjohnson wants to merge 3 commits intostaging/eeveefrom
Conversation
|
✅ Deploy Preview for red-hat-design-system ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Documentation Health
|
| Category | Score | |
|---|---|---|
| Element description | 8/25 | ❌ |
| Attribute documentation | 20/20 | ✅ |
| Slot documentation | 10/15 | |
| CSS documentation | 10/15 | |
| Event documentation | 15/15 | ✅ |
| Demos | 5/10 |
Recommendations:
- rh-button-group: describe purpose and context using words like 'for', 'when', 'provides', 'allows' (Element description, +5 pts)
- rh-button-group: use RFC 2119 keywords (MUST, SHOULD, AVOID) to clarify requirements (Element description, +5 pts)
- rh-button-group: mention accessibility considerations for slot content (Slot documentation, +5 pts)
- rh-button-group: reference design tokens or theme considerations in CSS descriptions (CSS documentation, +5 pts)
- rh-button-group: add descriptions to demos (Demos, +5 pts)
Contributor
|
Size Change: +193 B (+0.07%) Total Size: 261 kB
ℹ️ View Unchanged
|
bennypowers
requested changes
Feb 25, 2026
Member
bennypowers
left a comment
bennypowers
left a comment
There was a problem hiding this comment.
This ought to be summarized (with rfc2119 keywords) in the jsdoc
bennypowers
requested changes
Mar 6, 2026
Member
There was a problem hiding this comment.
this has to go in the appropriate places on public apis like slots and attr, or in the element description, otherwise it won't make it into the final manifest
see #2738 for examples
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What I did
role="group"androle="toolbar"to the<rh-button-group>Accessibility page.<rh-button-group>: add accessibility docs #2769.Testing Instructions
<rh-button-group>in the DP.