Conversation
Closed
Contributor
Reviewer's GuideRefactors auro-button documentation to separate minimal landing-page content from detailed API usage, expands and reorganizes API examples (including shape, loading, accessibility, and CSS parts), improves descriptions and custom registration guidance, and slightly updates component JSDoc without changing runtime behavior. Updated class diagram for AuroButton componentclassDiagram
class AuroButton {
<<customElement>>
+string appearance
+boolean autofocus
+boolean disabled
+boolean fluid
+boolean formAssociated
+string layout
+boolean loading
+string loadingText
+boolean onDark
+string shape
+string size
+boolean static
+string tabindex
+string tIndex
+string title
+string type
+string value
+string variant
+static void register(name)
}
class AuroElement {
}
AuroButton --|> AuroElement
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- In docs/api.md the properties table no longer lists the
typeandvariantproperties (even though they are still documented in JSDoc and used by the component); consider restoring rows for these so the API reference stays complete. - The methods table in docs/api.md has lost the
registermethod entry in this refactor; consider adding the method back into the table so consumers can still discover the custom-registration API from the main reference.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In docs/api.md the properties table no longer lists the `type` and `variant` properties (even though they are still documented in JSDoc and used by the component); consider restoring rows for these so the API reference stays complete.
- The methods table in docs/api.md has lost the `register` method entry in this refactor; consider adding the method back into the table so consumers can still discover the custom-registration API from the main reference.
## Individual Comments
### Comment 1
<location> `docs/partials/api.md:342-351` </location>
<code_context>
</auro-accordion>
-## Fluid
+#### Aria Labelledby
-In the following example see how the `fluid` attributes alters the shape of the button to be full width of its parent container.
+The component supports both the `aria-labelledby` attribute for accessibility.
<div class="exampleWrapper">
- <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/fluid.html) -->
+ <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../apiExamples/aria-labeledby.html) -->
<!-- AURO-GENERATED-CONTENT:END -->
</div>
<auro-accordion alignRight>
<span slot="trigger">See code</span>
-<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/fluid.html) -->
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/aria-labeledby.html) -->
<!-- AURO-GENERATED-CONTENT:END -->
</code_context>
<issue_to_address>
**suggestion (typo):** Align spelling of “labelled/labeled” with the `aria-labelledby` attribute for consistency.
The heading, example filename, and attribute currently use three different spellings. Please standardize them to match the actual attribute name (`aria-labelledby`), including the example file (`aria-labelledby.html`).
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
rmenner
approved these changes
Jan 29, 2026
|
🎉 This PR is included in version 12.3.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
4 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.
Alaska Airlines Pull Request
Checklist can be skipped because this PR just contains doc changes - @jordanjones243
Review Checklist:
RC Checklist
Testing Checklist:
Browsers
Browsers Support Guide
Dev demo link
Android
iOS
Desktop
Scenarios
Framework playground
**By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.**
Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.
Thank you for your submission!
-- Auro Design System Team
Summary by Sourcery
Refine auro-button documentation structure and demos while adding targeted API and styling examples.
Enhancements:
Documentation: