AlaskaAirlines / auro-avatar

Custom element for the purpose of displaying an avatar image.
https://auro.alaskaair.com/components/auro/avatar
Apache License 2.0
1 stars 0 forks source link

Move theming support from Beta to Main #59

Closed jordanjones243 closed 1 month ago

jordanjones243 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: #53

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 for the auro-avatar component from beta to main, enabling customization through design tokens. Refactor color and size tokens for better maintainability and flexibility. Update documentation to reflect these changes and adjust tests to ensure correct functionality.

New Features:

Enhancements:

Documentation:

Tests:

CLAassistant commented 2 months 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.

sourcery-ai[bot] commented 2 months ago

Reviewer's Guide by Sourcery

This pull request moves theming support from Beta to Main for the auro-avatar component. The changes focus on refactoring color tokens, replacing hard-coded values with size tokens, and introducing theme support. The implementation includes updates to styles, documentation, and tests.

File-Level Changes

Files Changes
src/style.scss
src/tokens.scss
Refactored color tokens using tier 3 tokens for improved theming flexibility
src/style.scss Replaced hard-coded size values with design system size tokens
demo/api.md
docs/partials/api.md
Added theme support documentation and code samples
README.md Updated component version and CDN link in README
test/auro-avatar.test.js Modified test case for avatar image source
src/tokens.scss Added new tokens.scss file for custom property definitions
src/auro-avatar.js Updated component styles to include new token CSS
CHANGELOG.md Updated CHANGELOG with new version and feature information

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.
DukeFerdinand commented 1 month ago

Hmmm this seems to be broken (at least running locally). I would imagine there's supposed to be some examples rendering here?

It's building the code correctly as far as I can tell, but it's not actually rendering any image to the page.

Screenshot 2024-09-18 at 11 08 23 AM
jordanjones243 commented 1 month ago

Just checked my localhost and it works for me! @DukeFerdinand

Screen Shot 2024-09-18 at 2 53 53 PM
blackfalcon commented 1 month ago

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

The release is available on:

Your semantic-release bot :package::rocket: