Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update Avatar to use createStencil and createComponent #2793

Merged
merged 40 commits into from
Aug 7, 2024

Conversation

kaconant
Copy link
Contributor

@kaconant kaconant commented Jun 24, 2024

Summary

Fixes: #1738
Refactored Avatar to use our new styling utilities and tokens. Also updated documentation to use MDX.

Release Category

Components

Release Note

The Avatar component has been refactored to use our new tokens and styling utilities. The changes below highlight the breaking changes to the API.

BREAKING CHANGES

  • Avatar no longer uses SystemIconCircle for sizing.
  • Avatar.Size is no longer supported. The size prop type has change to accept the following: "extraExtraLarge" | "extraLarge" | "large" | "medium" | "small" | "extraSmall" | (string{})
  • Avatar.Variant is no longer supported. Enum AvatarVariant has been removed. The variant type prop now accepts "dark" | "light"
  • The as prop now accepts any element, not just div.

Checklist

Will do the following once have a more stable branch!

For the Reviewer

  • PR title is short and descriptive
  • PR summary describes the change (Fixes/Resolves linked correctly)
  • PR Release Notes describes additional information useful to call out in a release message or removed if not applicable
  • Breaking Changes provides useful information to upgrade to this code or removed if not applicable

Where Should the Reviewer Start?

  • Review to see if direction is right. Currently working with @mannycarrera4.

Areas for Feedback? (optional)

  • Code
  • Documentation
  • Testing
  • Codemods

Testing Manually

Screenshots or GIFs (if applicable)

Screenshot 2024-06-27 at 10 10 20 AM
Screenshot 2024-06-27 at 10 10 26 AM
Screenshot 2024-06-27 at 10 10 31 AM

Thank You Gif

a turtle and hare racing

Copy link

cypress bot commented Jun 28, 2024



Test summary

847 0 3 0Flakiness 0


Run details

Project Workday/canvas-kit
Status Passed
Commit e696505 ℹ️
Started Aug 7, 2024 3:39 PM
Ended Aug 7, 2024 3:44 PM
Duration 04:48 💡
OS Linux Ubuntu - 22.04
Browser Electron 94

View run in Cypress Cloud ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Cloud

@mannycarrera4 mannycarrera4 added 12.x ready for review Code is ready for review labels Jul 3, 2024
@github-actions github-actions bot requested a review from NicholasBoll July 3, 2024 15:03
@mannycarrera4 mannycarrera4 removed the ready for review Code is ready for review label Jul 8, 2024
@mannycarrera4 mannycarrera4 added the ready for review Code is ready for review label Aug 1, 2024
Copy link
Contributor

@mannycarrera4 mannycarrera4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work! Way to push through, thank you for working on this!

@mannycarrera4 mannycarrera4 added automerge and removed ready for review Code is ready for review labels Aug 7, 2024
@alanbsmith alanbsmith merged commit 3b7726a into Workday:prerelease/major Aug 7, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants