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

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

sun-mota
Copy link
Contributor

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

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

Summary:

AuroTable.register is to easily register the element without extra importing
import "@aurodesignsystem/auro-table" will still register this element to
import { AuroTable } from '../src/auro-table.js wont register this element until AuroTable.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 AuroTable.register to facilitate the registration of the auro-table custom element with a specified name, update the documentation to reflect this change, and fix a typo in the documentation. Enhance the build configuration to include demo examples.

New Features:

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

Bug Fixes:

  • Correct a typo in the documentation from 'clement' to 'element'.

Enhancements:

  • Update the Rollup configuration to include a new build target for demo examples.

Documentation:

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

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

sourcery-ai bot commented Oct 21, 2024

Reviewer's Guide by Sourcery

This pull request adds a static register method to the AuroTable class, simplifying the process of registering the custom element. It also includes minor documentation updates and configuration changes to support this new functionality.

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

File-Level Changes

Change Details Files
Added a static register method to the AuroTable class
  • Implemented AuroTable.register(name) method to register the component with a custom name
  • Removed the automatic registration of 'auro-table' custom element
  • Updated documentation to reflect the new registration method
src/auro-table.js
docs/partials/index.md
demo/index.md
Updated build configuration and demo setup
  • Added a new Rollup configuration for demo index file
  • Updated demo HTML to use the new registration method
rollup.config.mjs
demo/index.html
Fixed typos in documentation
  • Corrected 'clement' to 'element' in documentation
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

@sun-mota sun-mota self-assigned this Oct 21, 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 - here's some feedback:

Overall Comments:

  • Consider maintaining backwards compatibility by keeping the default element registration alongside the new register method. This could be done by wrapping the default registration in a condition that checks if the element is already defined.
  • Please explain the reasoning behind the changes to the rollup configuration, specifically the addition of the new indexExamplesConfig build target for the demo.
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: all looks good

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.min.js Show resolved Hide resolved
demo/index.min.js Show resolved Hide resolved
demo/index.js Outdated Show resolved Hide resolved
`AuroTable.register` is to easily register the element without extra importing
`import "@aurodesignsystem/auro-table"` will still register this element to <auro-table>
`import { AuroTable } from '../src/auro-table.js` wont register this element until `AuroTable.register` gets called

Fixed the typo on Recommended Use and Version Control.
`clement` -> `element`
@sun-mota sun-mota force-pushed the sunMota/feat/easierRegistry/92 branch from 242d4ec to 73bc4fa Compare October 21, 2024 18:53
@sun-mota sun-mota merged commit 96d0069 into master Oct 21, 2024
6 checks passed
@sun-mota sun-mota deleted the sunMota/feat/easierRegistry/92 branch October 21, 2024 20:11
@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 21, 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