-
Notifications
You must be signed in to change notification settings - Fork 0
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 #211
Conversation
Reviewer's Guide by SourceryThis pull request adds a new static Class diagram for AuroSelect with new register methodclassDiagram
class AuroSelect {
+static register(name="auro-select")
+updateDisplayedValue(option)
}
note for AuroSelect "The register method allows custom element registration."
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 and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 2 issues found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
`AuroSelect.register` is to easily register the element without extra importing `import '@aurodesignsystem/auro-select'` will still register this element to `<auro-select>` `import { AuroSelect } from '../src/auro-select.js` wont register this element until `AuroSelect.register` gets called
72fec07
to
754a9d6
Compare
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.
I think we need to revisit how many is used and registered for use. Let's discuss some options in a pair programming session.
Also, I am pretty sure many of the CDN imports on the demo index and api pages are no longer needed.
1. `auro-select` will not import `auro-menu` inside. 2. `auro-select` can take customized menu as a child
removed `auro-icon`, `auro-button`, etc from `index.html` and `api.html`
16f7585
to
59b4666
Compare
🎉 This PR is included in version 3.1.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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: #210
Summary:
AuroSelect.register
is to easily register the element without extra importingimport '@aurodesignsystem/auro-select'
will still register this element to<auro-select>
import { AuroSelect } from '../src/auro-select.js
wont register this element untilAuroSelect.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 'register' method to the AuroSelect class to facilitate dynamic registration of custom elements, replacing the previous direct registration approach. Update documentation to guide users on using the new method.
New Features:
Enhancements:
Documentation: