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 #211

Merged
merged 4 commits into from
Oct 30, 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: #210

Summary:

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

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 '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:

  • Introduce a static method 'register' in AuroSelect class to allow dynamic registration of custom elements.

Enhancements:

  • Remove direct registration of 'auro-select' in favor of using the new 'register' method.

Documentation:

  • Update documentation to reflect the new 'register' method for registering custom elements.

@sun-mota sun-mota self-assigned this Oct 17, 2024
@sun-mota sun-mota requested a review from a team as a code owner October 17, 2024 23:07
@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 AuroSelect class, simplifying the process of registering the component with a custom name. It also removes the automatic registration of the default "auro-select" element, requiring explicit registration for all use cases.

Class diagram for AuroSelect with new register method

classDiagram
    class AuroSelect {
        +static register(name="auro-select")
        +updateDisplayedValue(option)
    }
    note for AuroSelect "The register method allows custom element registration."
Loading

File-Level Changes

Change Details Files
Added a new static register method to the AuroSelect class
  • Implemented AuroSelect.register(name) method with an optional parameter defaulting to 'auro-select'
  • Method uses AuroLibraryRuntimeUtils.prototype.registerComponent for registration
  • Added JSDoc comments explaining the usage of the new method
src/auro-select.js
Removed automatic registration of 'auro-select' custom element
  • Deleted the code block that automatically defined 'auro-select' custom element
  • This change requires users to explicitly register the component
src/auro-select.js
Updated demo and documentation to use the new registration method
  • Removed import of RuntimeUtils and its usage in demo/index.html
  • Added AuroSelect.register('custom-select') in demo/index.js
  • Updated code examples in demo/index.md and docs/partials/index.md
demo/index.html
demo/index.js
demo/index.md
docs/partials/index.md
Updated version number in dropdownVersion.js
  • Changed version from '3.0.0' to an unspecified new version
src/dropdownVersion.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

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: 1 issue found
  • 🟢 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.

src/auro-select.js Show resolved Hide resolved
demo/index.md Outdated Show resolved Hide resolved
docs/partials/index.md Outdated Show resolved Hide resolved
demo/index.min.js Outdated Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
`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
@sun-mota sun-mota force-pushed the sunMota/feat/easierRegistry/210 branch from 72fec07 to 754a9d6 Compare October 21, 2024 18:24
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.

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`
@sun-mota sun-mota force-pushed the sunMota/feat/easierRegistry/210 branch from 16f7585 to 59b4666 Compare October 21, 2024 23:13
@sun-mota sun-mota merged commit c7bcfac into main Oct 30, 2024
6 checks passed
@sun-mota sun-mota deleted the sunMota/feat/easierRegistry/210 branch October 30, 2024 03:16
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Oct 30, 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