RC #384#385
Merged
Merged
Conversation
Contributor
Reviewer's GuideRefactors auro-button documentation and project config while adding guidance for custom element version management, expanding issue/PR templates, updating tooling/dependencies, and improving loading/ARIA behavior and loader layout. Sequence diagram for custom element registration and version managementsequenceDiagram
actor Developer
participant AppModule
participant CustomElementsRegistry
participant Document
Developer->>AppModule: import AuroButtonClass
Developer->>AppModule: AuroButtonClass.register(custom_button)
AppModule->>CustomElementsRegistry: define(custom_button, AuroButtonClass)
Developer->>Document: Add <custom-button> elements in HTML
CustomElementsRegistry-->>Document: Upgrade custom-button to AuroButton instances
Class diagram for AuroElement and AuroButton loading/version-related structureclassDiagram
class AuroElement {
+boolean onDark
+string appearance
+AuroElement()
}
class AuroButton {
+boolean loading
+boolean disabled
+boolean static
+boolean fluid
+boolean formAssociated
+string variant
+string size
+string shape
+string type
+string value
+string title
+string tabindex
+string tIndex
+string loadingText
+string currentAriaLabel
+string currentAriaLabelledBy
+string generateAriaLabel()
+void register(name)
}
AuroButton --|> AuroElement
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Closed
jason-capsule42
approved these changes
Jan 13, 2026
![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 3 issues, and left some high level feedback:
- In
auro-buttonthecontentClasseskey was changed fromutil_displayHiddenVisuallytoloading, but there’s no corresponding.loadingstyle instyle.scss, so the button label may no longer be visually hidden while loading; consider either keeping the original utility class or adding a matching.loadingrule. - The
loaderVersion.jsexport still reports'6.0.0'while@aurodesignsystem/auro-loaderwas bumped to^6.1.0; it would be good to update this version constant to stay in sync with the actual loader dependency. - In
docs/api.md, the Methods table header remains but no longer documents theregister(name)method, even though README text still references it; consider adding back (or updating) the method row so the API docs stay aligned with the described usage.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `auro-button` the `contentClasses` key was changed from `util_displayHiddenVisually` to `loading`, but there’s no corresponding `.loading` style in `style.scss`, so the button label may no longer be visually hidden while loading; consider either keeping the original utility class or adding a matching `.loading` rule.
- The `loaderVersion.js` export still reports `'6.0.0'` while `@aurodesignsystem/auro-loader` was bumped to `^6.1.0`; it would be good to update this version constant to stay in sync with the actual loader dependency.
- In `docs/api.md`, the Methods table header remains but no longer documents the `register(name)` method, even though README text still references it; consider adding back (or updating) the method row so the API docs stay aligned with the described usage.
## Individual Comments
### Comment 1
<location> `src/auro-button.js:471` </location>
<code_context>
const contentClasses = {
contentWrapper: true,
- util_displayHiddenVisually: this.loading,
+ loading: this.loading,
};
</code_context>
<issue_to_address>
**issue (bug_risk):** Switching from `util_displayHiddenVisually` to `loading` may break the visually-hidden behavior during loading.
`util_displayHiddenVisually` likely applied a shared visually-hidden pattern (hidden visually but exposed to screen readers). Unless `.loading` now provides equivalent styles, this change may regress accessibility or show duplicate content with the loader. Please either retain the utility or ensure `.loading` (or another class) implements the same visually-hidden behavior.
</issue_to_address>
### Comment 2
<location> `README.md:51` </location>
<code_context>
+* submit a form
+* begin a new task
+* trigger a new UI element to appear to the page
+* specify a new or next step in a process
<!-- AURO-GENERATED-CONTENT:END -->
</code_context>
<issue_to_address>
**suggestion (typo):** Consider rephrasing this bullet to use "on the page" instead of "to the page".
For example, you could write: `* trigger a new UI element to appear on the page`.
```suggestion
* trigger a new UI element to appear on the page
```
</issue_to_address>
### Comment 3
<location> `docs/api.md:12` </location>
<code_context>
+| layout | layout | | string | `{'default'}` | Override layout since it isn't used in this component. |
</code_context>
<issue_to_address>
**question:** Double-check whether the `{'default'}` value for `layout` is the intended default formatting.
This default stands out from other string defaults in the table. If the default is the string `default`, consider formatting it as `` `default` `` for consistency. If it’s meant to be a non-string value, please clarify that in the type or description.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
🎉 This PR is included in version 12.3.1 🎉 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
3 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
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
Update auro-button documentation, accessibility behavior, tooling, and repository configuration.
New Features:
Bug Fixes:
Enhancements:
Build:
CI:
Deployment:
Documentation:
Tests:
Chores: