-
Notifications
You must be signed in to change notification settings - Fork 6
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
feat(api): add register static method #145
Conversation
Surge demo deployment failed! 😭 |
Reviewer's Guide by SourceryThis pull request adds a static Updated class diagram for AuroRadio and AuroRadioGroupclassDiagram
class AuroRadio {
+static register(name="auro-radio")
...
}
class AuroRadioGroup {
+static register(name="auro-radio-group")
...
}
note for AuroRadio "Added static register method"
note for AuroRadioGroup "Added static register method"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @sun-mota - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider refactoring the
register
method implementation to avoid usingAuroLibraryRuntimeUtils.prototype.registerComponent
. This mixing of old and new approaches could lead to maintenance issues. A more direct registration method would be preferable. - Enhance the documentation to more clearly explain the differences between the old
registerComponent
approach and the newregister
method. Emphasize thatAuroRadio.register()
andAuroRadioGroup.register()
need to be called separately, unlike the previous method. - Consider adding a deprecation notice for the old
registerComponent
method and provide migration guidelines to help users transition to the newregister
method smoothly.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
AuroRadio.register is to easily register the element without extra importing `import "@aurodesignsystem/auro-radio"` will still register this element to <auro-radio> `import { AuroRadio } from '../src/auro-radio.js` wont register this element until AuroRadio.register gets called Same chages applied to AuroRadioGroup
e56e8dc
to
096d82d
Compare
refactor to radio-group to select custom radio elements
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.
Localhost isn't running for me.
🎉 This PR is included in version 4.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Same chages applied to AuroRadioGroup
Alaska Airlines Pull Request
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Resolves: #144
Summary:
AuroRadio.register
is to easily register the element without extra importingimport "@aurodesignsystem/auro-radio"
will still register this element to<auro-radio>
import { AuroRadio.register } from '../src/auro-radio
will NOT register this element untilAuroRadio.register
gets calledSame changes applied to
AuroRadioGroup
Type of change:
Please delete options that are not relevant.
Checklist:
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
Add a static register method to AuroRadio and AuroRadioGroup for manual element registration, update build configuration for demo files, and revise documentation to explain the new registration process.
New Features:
Enhancements:
Build:
Documentation: