Skip to content
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 #196

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Conversation

sun-mota
Copy link
Contributor

@sun-mota sun-mota commented Oct 17, 2024

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: #195

Summary:

AuroCombobox.register is to easily register the element without extra importing
import "@aurodesignsystem/auro-combobox" will still register this element to <auro-combobox>
import { AuroCombobox } from '../src/auro-combobox.js won't register this element until AuroCombobox.register gets called

Type of change:

Please delete options that are not relevant.

  • New capability
  • Revision of an existing capability
  • Infrastructure change (automation, etc.)
  • Other (please elaborate)

Checklist:

  • My update follows the CONTRIBUTING guidelines of this project
  • I have performed a self-review of my own update

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 'register' to the AuroCombobox class to facilitate the registration of the component with a custom name, simplifying the process and updating the documentation accordingly.

New Features:

  • Introduce a static method 'AuroCombobox.register' to allow easy registration of the auro-combobox element with a custom name.

Enhancements:

  • Simplify the registration process of the auro-combobox element by removing the need for external runtime utilities.

Documentation:

  • Update documentation to reflect the new registration method for the auro-combobox element.

@sun-mota sun-mota requested a review from a team as a code owner October 17, 2024 19:19
@sun-mota sun-mota linked an issue Oct 17, 2024 that may be closed by this pull request
Copy link

sourcery-ai bot commented Oct 17, 2024

Reviewer's Guide by Sourcery

This pull request adds a new static register method to the AuroCombobox class, simplifying the process of registering the component with a custom name. It also updates the documentation and examples to reflect this new method.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new static register method to the AuroCombobox class
  • Implemented the register method with an optional name parameter
  • Method uses AuroLibraryRuntimeUtils.prototype.registerComponent internally
src/auro-combobox.js
Updated documentation and examples to use the new register method
  • Modified code snippets in documentation to use AuroCombobox.register()
  • Removed references to RuntimeUtils and registerComponent
  • Updated example initialization in demo files
demo/index.md
docs/partials/index.md
demo/index.html
demo/index.js

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sun-mota sun-mota self-assigned this Oct 17, 2024
Copy link

@sourcery-ai sourcery-ai bot left a 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: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

demo/index.md Show resolved Hide resolved
docs/partials/index.md Outdated Show resolved Hide resolved
@sun-mota sun-mota force-pushed the sunMota/feat/easierRegistry/195 branch from 99aac14 to f2eaa63 Compare October 17, 2024 19:26
AuroCombobox.register is to easily register the element without extra importing
`import "@aurodesignsystem/auro-combobox"` will still register this element to <auro-combobox>
`import { AuroCombobox } from '../src/auro-combobox.js` wont register this element until AuroCombobox.register gets called
@sun-mota sun-mota force-pushed the sunMota/feat/easierRegistry/195 branch from cba820a to 2039d21 Compare October 21, 2024 18:22
Copy link
Member

@jason-capsule42 jason-capsule42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to revisit how we are registering menu

1. `auro-combobox` will not import `auro-menu` inside.
2. `auro-combobox` can take customized menu as a child
@sun-mota sun-mota merged commit 78bb949 into main Oct 24, 2024
6 checks passed
@sun-mota sun-mota deleted the sunMota/feat/easierRegistry/195 branch October 24, 2024 16:54
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update component registration logic
3 participants