feat(api): add register static method

[sun-mota]

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

Summary:

AuroToast.register is to easily register the element without extra importing
import "@aurodesignsystem/auro-toast" will still register this element to
import { AuroToast } from '../src/auro-toast.js wont register this element until AuroToast.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 AuroToast.register to facilitate the registration of the auro-toast element with a custom name, and update documentation to reflect this change. Remove the default element registration to encourage the use of the new method.

New Features:

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

Enhancements:

• Remove the default internal definition of the auro-toast element to rely on the new register method for element registration.

Documentation:

• Correct typos in documentation, changing 'clement' to 'element'.
• Update documentation to reflect the new AuroToast.register method for registering custom elements.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a new static register method to the AuroToast class, simplifying the process of registering the custom element. It also updates the documentation and demo to reflect this change, and fixes a typo in the documentation.

Class diagram for AuroToast with new register method

classDiagram
    class AuroToast {
        +static register(name="auro-toast")
        +firstUpdated()
    }
    note for AuroToast "Added static register method to simplify element registration"

Loading

File-Level Changes

Change	Details	Files
Added a new static register method to the AuroToast class	Implemented AuroToast.register method with an optional name parameter Method uses AuroLibraryRuntimeUtils.prototype.registerComponent to register the component Removed the default internal definition of the custom element	src/auro-toast.js
Updated demo and documentation to use the new register method	Removed old registration code using RuntimeUtils Added example of using AuroToast.register('custom-toast') in demo Updated documentation to reflect the new registration method	demo/index.html demo/index.md docs/partials/index.md demo/index.js
Fixed a typo in the documentation	Changed 'custom clement' to 'custom element' in multiple files	demo/index.md docs/partials/index.md

---

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.

[sourcery-ai]

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

After running a build there are 4 files with changes that aren't checked into this PR.

[blackfalcon]

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀