AlaskaAirlines / auro-menu

Custom element that provides a list of options for the user to choose from
https://auro.alaskaair.com/components/auro/menu
Apache License 2.0
2 stars 3 forks source link

Beta #214

Closed jordanjones243 closed 1 month ago

jordanjones243 commented 1 month ago

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: # (issue, if applicable)

Summary:

Please summarize the scope of the changes you have submitted, what the intent of the work is and anything that describes the before/after state of the project.

Type of change:

Please delete options that are not relevant.

Checklist:

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

Release version 4.0.0-beta.1 with new features including component name attributes and theme support. Fix import and token naming issues. Enhance color token usage and component registration. Update dependencies and clean up build scripts. Update documentation to reflect new theme support and remove outdated information.

New Features:

Bug Fixes:

Enhancements:

Build:

Documentation:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request implements several significant changes to the auro-menu component, including updating dependencies, refactoring color tokens, improving performance, and adding support for theme customization. The changes are part of a beta release (v4.0.0-beta.1) and include breaking changes related to color theme support.

Sequence Diagram

sequenceDiagram
    participant App
    participant RuntimeUtils
    participant AuroMenu
    participant CustomElements

    App->>RuntimeUtils: registerComponent('custom-menu', AuroMenu)
    RuntimeUtils->>CustomElements: define('custom-menu', ExtendedAuroMenu)
    CustomElements-->>RuntimeUtils: OK
    RuntimeUtils-->>App: Component Registered

File-Level Changes

Change Details Files
Refactored color tokens to use tier 3 tokens
  • Updated color-related CSS to use new token variables
  • Added new color-menu.scss and color-menuoption.scss files for color-specific styles
  • Created a tokens.scss file for defining custom properties for theming
src/style-menu.scss
src/style-menuoption.scss
src/color-menu.scss
src/color-menuoption.scss
src/tokens.scss
Updated dependencies and build process
  • Updated various dependency versions in package.json
  • Removed unused script files (generateDocs.mjs, postCss.mjs, prepForBuild.mjs, staticStyles-template.js)
  • Added eslint.config.mjs for new ESLint configuration
package.json
eslint.config.mjs
scripts/generateDocs.mjs
scripts/postCss.mjs
scripts/prepForBuild.mjs
scripts/staticStyles-template.js
Improved performance and modernized code
  • Refactored custom registration config
  • Updated to use auro-icon for selected check mark
  • Added component name as attribute during custom registration
  • Updated all imports to include extension in file path
src/auro-menu.js
src/auro-menuoption.js
index.js
Added support for theme customization
  • Added new CSS custom properties for theming in tokens.scss
  • Updated documentation to include information about theme support
src/tokens.scss
demo/api.md
docs/partials/api.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. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) 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](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
CLAassistant commented 1 month ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

:white_check_mark: jordanjones243
:white_check_mark: jason-capsule42
:x: semantic-release-bot
You have signed the CLA already but the status is still pending? Let us recheck it.