AlaskaAirlines / auro-icon

Custom HTML element for the use of easily displaying an icon from the Auro Icon library
https://auro.alaskaair.com/components/auro/icon
Apache License 2.0
0 stars 4 forks source link

Move theming support from Beta to Main #129

Closed jordanjones243 closed 4 weeks 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: #112

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 introducing custom SVG support, adding new icon styles, and updating documentation and tests accordingly.

New Features:

Enhancements:

Documentation:

Tests:

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

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

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request updates the auro-icon component to support theming and introduces several new features and changes. The main changes include:

  1. Added support for custom SVG icons
  2. Introduced new color variants (info, secondary, tertiary, subtle)
  3. Deprecated the 'primary' attribute
  4. Removed the 'advisory' attribute (replaced by 'warning')
  5. Updated the styling to use CSS custom properties for better theming support
  6. Refactored the component to improve customization and flexibility
  7. Updated documentation and examples to reflect the new changes
  8. Added new tests for the new features

The implementation focuses on enhancing the component's flexibility and aligning it with the latest design system guidelines.

File-Level Changes

Files Changes
src/auro-icon.js
demo/api.md
apiExamples/customSvg.html
Added support for custom SVG icons using the 'customSvg' attribute
src/auro-icon.js
src/color.scss
apiExamples/visualState.html
apiExamples/onDark.html
Introduced new color variants: info, secondary, tertiary, and subtle
src/auro-icon.js
docs/api.md
Deprecated the 'primary' attribute and removed the 'advisory' attribute
src/color.scss
src/tokens.scss
src/style.scss
Updated styling to use CSS custom properties for better theming support
src/auro-icon.js
src/baseIcon.js
Refactored the component to improve customization and flexibility
demo/api.md
docs/api.md
README.md
CHANGELOG.md
Updated documentation and examples to reflect the new changes
test/auro-icon.test.js Added new tests for the new features and refactored existing tests
package.json
index.js
Updated build configuration and dependencies

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.