jason-capsule42 commented 2 months 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, #124, #128

Type of change:

Please delete options that are not relevant.

[x] New capability
[x] Revision of an existing capability
[ ] Infrastructure change (automation, etc.)
[ ] Other (please elaborate)

Checklist:

[x] My update follows the CONTRIBUTING guidelines of this project
[x] 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 support for custom SVG icons and new icon styles, enhance theme support, and update documentation and tests accordingly.

New Features:

Introduce support for custom SVG icons using the customSvg attribute, allowing users to render any SVG content within the auro-icon component.
Add new icon styles including info, secondary, subtle, and tertiary to enhance visual customization options.

Enhancements:

Deprecate the primary icon style in favor of more specific styles.
Enhance theme support by allowing the component to be restyled using design tokens, improving customization capabilities.

Documentation:

Update documentation to include examples and usage of the new customSvg attribute and additional icon styles.
Add a section on theme support, detailing how to restyle the component using design tokens.

Tests:

Add tests to verify the registration of auro-icon as a custom element with a custom name.
Remove outdated tests related to the advisory style and update tests to reflect the new icon styles and attributes.

CLAassistant commented 2 months ago

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 2 months ago

Reviewer's Guide by Sourcery

This pull request introduces significant updates to the auro-icon component, enhancing its functionality and customization options. The changes include support for custom SVG icons, new icon styles, improved theme support, and updated documentation. The primary focus is on implementing these new features while maintaining backwards compatibility and improving the overall flexibility of the component.

File-Level Changes

Files	Changes
`src/auro-icon.js` `demo/api.md` `apiExamples/customSvg.html`	Add support for custom SVG icons using the `customSvg` attribute
`src/auro-icon.js` `src/color.scss` `apiExamples/visualState.html` `apiExamples/onDark.html`	Introduce new icon styles including `info`, `secondary`, `subtle`, and `tertiary`
`src/auro-icon.js` `docs/api.md`	Deprecate the `primary` icon style
`src/tokens.scss` `src/color.scss`	Enhance theme support by allowing the component to be restyled using design tokens
`demo/api.md` `docs/api.md` `README.md`	Update documentation to reflect new features and changes
`src/auro-icon.js` `src/baseIcon.js`	Refactor component structure for better maintainability
`test/auro-icon.test.js`	Add tests for new features and functionality
`CHANGELOG.md` `package.json`	Update build and configuration files

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.

jason-capsule42 commented 2 months ago

@sourcery-ai review

blackfalcon commented 2 months ago

:tada: This PR is included in version 4.5.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

AlaskaAirlines / auro-icon

Release Beta to Main #130