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.

Sign up for GitHub

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

Jump to bottom

[Skeleton] Rename variant circle -> circular and rect -> rectangular for consistency #22053

Merged
merged 7 commits into from
Aug 4, 2020
Merged

[Skeleton] Rename variant circle -> circular and rect -> rectangular for consistency #22053

merged 7 commits into from
Aug 4, 2020

Conversation

kodai3
Copy link
Contributor

@kodai3 kodai3 commented Aug 3, 2020 •
edited by eps1lon
Loading

Breaking changes

  • Rename circle to circular and rect to rectangular for consistency. The possible values should be adjectives, not nouns:

    -<Skeleton variant="circle">
-<Skeleton variant="rect">
+<Skeleton variant="circular">
+<Skeleton variant="rectangular">

Last item of #21964. Closes #21964

@mui-pr-bot
Copy link

mui-pr-bot commented Aug 3, 2020 •
edited
Loading

Details of bundle changes

Generated by 🚫 dangerJS against 42cac3e

@oliviertassinari oliviertassinari changed the title [Skelton] Rename variant circle -> circular and rect -> rectangular for consistency [Skeleton] Rename variant circle -> circular and rect -> rectangular for consistency Aug 3, 2020
@oliviertassinari oliviertassinari added the component: skeleton This is the name of the generic UI component, not the React module! label Aug 3, 2020
mnajdova
mnajdova approved these changes Aug 3, 2020
View reviewed changes
Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

LGTM, I am just wondering whether we should also document in the breaking changes the changes to the classKeys, as the possible overrides from the clients would break too with this change.

@kodai3
Copy link
Contributor Author

kodai3 commented Aug 3, 2020 •
edited
Loading

@mnajdova Thank you for pointing out.
Overriding with classKeys is common usecase, so I think we should👍

42cac3e

@kodai3 kodai3 mentioned this pull request Aug 3, 2020
Merged
@oliviertassinari oliviertassinari merged commit f8632f1 into mui:next Aug 4, 2020
@oliviertassinari
Copy link
Member

@kodai3 Great :)

@kodai3 kodai3 deleted the update/rename-skelton-api-consistency branch August 4, 2020 09:02
@eps1lon eps1lon added this to the v5 milestone Sep 15, 2020
@oliviertassinari oliviertassinari mentioned this pull request Sep 15, 2020
Closed
42 tasks
@mbrookes mbrookes mentioned this pull request Sep 23, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oliviertassinari oliviertassinari oliviertassinari approved these changes

@mnajdova mnajdova mnajdova approved these changes

Assignees
No one assigned
Labels
breaking change component: skeleton This is the name of the generic UI component, not the React module!
Projects
None yet
Milestone
v5-beta
Development

Successfully merging this pull request may close these issues.

[RFC] Renaming API for consistency
5 participants
@kodai3 @mui-pr-bot @oliviertassinari @mnajdova @eps1lon