-
Notifications
You must be signed in to change notification settings - Fork 1
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 #93
Conversation
Reviewer's Guide by SourceryThis pull request adds a static No diagrams generated as the changes look simple and do not need a visual representation. 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 maintaining backwards compatibility by keeping the default element registration alongside the new
register
method. This could be done by wrapping the default registration in a condition that checks if the element is already defined. - Please explain the reasoning behind the changes to the rollup configuration, specifically the addition of the new
indexExamplesConfig
build target for the demo.
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: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
`AuroTable.register` is to easily register the element without extra importing `import "@aurodesignsystem/auro-table"` will still register this element to <auro-table> `import { AuroTable } from '../src/auro-table.js` wont register this element until `AuroTable.register` gets called Fixed the typo on Recommended Use and Version Control. `clement` -> `element`
242d4ec
to
73bc4fa
Compare
🎉 This PR is included in version 3.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Fixed the typo on Recommended Use and Version Control.
clement
->element
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: #92
Summary:
AuroTable.register
is to easily register the element without extra importingimport "@aurodesignsystem/auro-table"
will still register this element toimport { AuroTable } from '../src/auro-table.js
wont register this element untilAuroTable.register
gets calledType 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 method
AuroTable.register
to facilitate the registration of theauro-table
custom element with a specified name, update the documentation to reflect this change, and fix a typo in the documentation. Enhance the build configuration to include demo examples.New Features:
AuroTable.register
to allow easy registration of the custom element with a specified name.Bug Fixes:
Enhancements:
Documentation:
AuroTable.register
method for registering custom elements.