AlaskaAirlines / auro-sidenav

Custom element that provides users a way to create navigational interfaces
https://auro.alaskaair.com/components/auro/sidenav
Apache License 2.0
0 stars 1 forks source link

Move theming support from Beta to Main #32

Open jordanjones243 opened 3 weeks ago

jordanjones243 commented 3 weeks 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: #30

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

Move theming support from Beta to Main by implementing color theming capabilities for the Auro Sidenav component, refactoring the component for better version management, and updating documentation to reflect these changes. Enhance code maintainability by restructuring styles and adding an ESLint configuration.

New Features:

Enhancements:

Documentation:

Tests:

Chores:

CLAassistant commented 3 weeks 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.
1 out of 2 committers have signed the CLA.

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

sourcery-ai[bot] commented 3 weeks ago

Reviewer's Guide by Sourcery

This pull request implements theming support for the auro-sidenav component, moving it from Beta to Main. The changes primarily involve restructuring the CSS to support customizable color themes, introducing new SCSS files for color-specific styles, and updating the component's JavaScript files to incorporate these new styles. The implementation also includes the addition of custom properties for theming and updates to the documentation to reflect these new capabilities.

File-Level Changes

Files Changes
src/color-items.scss
src/color-sections.scss
src/color.scss
Restructured CSS by separating color-specific styles into new files (color-items.scss, color-sections.scss, color.scss)
src/tokens.scss Added custom properties for theming in a new tokens.scss file
src/auro-sidenav.js
src/auro-sidenavitem.js
src/auro-sidenavsection.js
Updated JavaScript files to import and use the new color and token stylesheets
src/style-items.scss
src/style-sections.scss
src/style.scss
Removed hardcoded color values from existing SCSS files and replaced them with custom properties
demo/api.md
docs/partials/api.md
Updated documentation to include information about theme support
eslint.config.mjs Added eslint configuration file for the project
CHANGELOG.md Updated CHANGELOG.md to reflect the new beta version with theming support
README.md Modified README.md to update the CDN link to the new beta version

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.