feat(api): add register static method

[sun-mota]

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

Summary:

AuroButton.register is to easily register the element without extra importing
import '@aurodesignsystem/auro-button' will still register this element to <auro-button>
import { AuroButton } from '../src/auro-button.js' wont register this element until AuroButton.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 AuroButton.register to facilitate the registration of the AuroButton element with a custom name, replacing the previous default registration approach. Update documentation and tests to align with this new method.

New Features:

• Introduce a static method AuroButton.register to allow dynamic registration of the AuroButton element with a custom name.

Enhancements:

• Remove the default internal definition of the auro-button element registration, requiring explicit registration using the new static method.

Documentation:

• Update documentation to reflect the new registration method AuroButton.register for custom element naming.

Tests:

• Modify tests to use the new AuroButton.register method for registering custom components.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a new static register method to the AuroButton class, simplifying the process of registering the component with a custom name. It also updates the documentation and demo files to reflect this new functionality, and removes the default internal definition of the "auro-button" custom element.

Class diagram for AuroButton with new register method

classDiagram
    class AuroButton {
        +static register(name="auro-button")
        +connectedCallback()
        +disconnectedCallback()
        +attributeChangedCallback(name, oldValue, newValue)
        +focus()
        +blur()
        +click()
        +render()
    }
    note for AuroButton "New static method 'register' added to simplify component registration"

Loading

File-Level Changes

Change	Details	Files
Add static register method to AuroButton class	Implement register method with optional name parameter Use RuntimeUtils to register the component Remove default internal definition of 'auro-button' custom element	src/auro-button.js
Update demo files to use new register method	Remove import of RuntimeUtils Replace RuntimeUtils.registerComponent with AuroButton.register Update code examples in documentation	demo/index.html demo/index.md docs/partials/index.md demo/index.js
Update unit tests for new register method	Replace RuntimeUtils.registerComponent with AuroButton.register in test case	test/auro-button.test.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-actions]

Surge demo deployment failed! 😭

[sourcery-ai]

Hey @sun-mota - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider keeping the default registration in addition to the new register method to maintain backward compatibility. This ensures existing implementations continue to work while providing the new flexibility.
• Update the documentation to clearly explain both the default registration and the new register method, including when and why a user might choose one over the other.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟡 Testing: 1 issue found
• 🟡 Complexity: 1 issue found
• 🟡 Documentation: 2 issues found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[jason-capsule42]

Files generated during the build are not checked in.

[blackfalcon]

🎉 This PR is included in version 8.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀