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

Rename ListItem leading and trailing element props #1533

Merged
merged 14 commits into from
Apr 14, 2022

Conversation

robinmetral
Copy link
Contributor

@robinmetral robinmetral commented Apr 13, 2022

Purpose

Rename ListItem leading and trailing element props for consistency with Figma and mobile platforms.

Approach and changes

  • Rename:
    • prefix into leadingComponent
    • suffix into trailingComponent
    • suffixLabel into trailingLabel
    • suffixDetails into trailingDetails
  • Rename internal use of this wording for consistency/clarity
  • Update specs and stories
  • Add a codemod for ListItem
  • Add a codemod for ListItemGroup 👈 this is too complex to codemod, we'll advise a search-and-replace migration strategy

Definition of done

  • Development completed
  • Reviewers assigned
  • Unit and integration tests
  • Meets minimum browser support
  • Meets accessibility requirements

@changeset-bot
Copy link

changeset-bot bot commented Apr 13, 2022

🦋 Changeset detected

Latest commit: aa15929

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sumup/circuit-ui Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@sumup-clark
Copy link

sumup-clark bot commented Apr 13, 2022

Hey @robinmetral,
we are super excited that you are contributing! 🎉There's one more thing you need to do. Please accept our Contributor License Agreement. It helps you and us to collaborate on clear terms and focus on what we love most: code.

Thanks!

@vercel
Copy link

vercel bot commented Apr 13, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sumup/oss-circuit-ui/6cfrbXvgYsaPti7Y547dETBamjjk
✅ Preview: https://oss-circuit-ui-git-listitem-prop-rename.sumup-vercel.app

Copy link
Member

@connor-baer connor-baer left a comment

Choose a reason for hiding this comment

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

The changes look good to me 👍

packages/circuit-ui/components/ListItem/ListItem.tsx Outdated Show resolved Hide resolved
@connor-baer
Copy link
Member

Don't forget to update the stories (I know this is WIP)

@codecov
Copy link

codecov bot commented Apr 14, 2022

Codecov Report

Merging #1533 (aa15929) into canary (fbcd19f) will decrease coverage by 0.00%.
The diff coverage is 92.68%.

Impacted file tree graph

@@            Coverage Diff             @@
##           canary    #1533      +/-   ##
==========================================
- Coverage   92.58%   92.57%   -0.01%     
==========================================
  Files         197      198       +1     
  Lines        4075     4083       +8     
  Branches     1238     1236       -2     
==========================================
+ Hits         3773     3780       +7     
- Misses        283      284       +1     
  Partials       19       19              
Impacted Files Coverage Δ
...ages/circuit-ui/cli/migrate/listitem-prop-names.ts 90.90% <90.90%> (ø)
...ckages/circuit-ui/components/ListItem/ListItem.tsx 95.12% <93.33%> (-0.18%) ⬇️

@robinmetral robinmetral marked this pull request as ready for review April 14, 2022 15:24
@robinmetral robinmetral requested a review from a team as a code owner April 14, 2022 15:24
@robinmetral robinmetral requested review from amelako and removed request for a team April 14, 2022 15:24
@robinmetral
Copy link
Contributor Author

✅ Verified the changes on Chromatic, stories were renamed but there are no visual changes

@robinmetral robinmetral mentioned this pull request Apr 14, 2022
2 tasks
.changeset/strange-seas-beam.md Outdated Show resolved Hide resolved
MIGRATION.md Outdated Show resolved Hide resolved
Co-authored-by: Connor Bär <connor-baer@users.noreply.github.com>
@robinmetral robinmetral enabled auto-merge (squash) April 14, 2022 15:46
@robinmetral robinmetral merged commit dec0db5 into canary Apr 14, 2022
@robinmetral robinmetral deleted the listitem-prop-rename branch April 14, 2022 15:55
This was referenced May 4, 2022
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.

2 participants