NumberControl: Add lint rule for 40px size prop usage #64561
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mirka
commented
Aug 15, 2024
Comment on lines
+19
to
+20
| /** Start opting into the larger default height that will become the default size in a future version. */ | ||
| __next40pxDefaultSize = false, |
There was a problem hiding this comment.
This was already being passed through via otherProps, but making it explicit here. All in-app usage already uses the correct size.
There was a problem hiding this comment.
Thought: instead of exposing __next40pxDefaultSize, could we instead just set __next40pxDefaultSize to true on NumberControl ? Or do we still care about offering consumers the option to opt-out of the new size, for the time being?
There was a problem hiding this comment.
I considered it, but checked third-party usage of some of these Typography controls and decided against it. They were used more than I thought, and some of them still use them in the old sizes, so decided against it.
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
28 tasks
|
Size Change: +18 B (0%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
ciampo
approved these changes
Aug 16, 2024
Comment on lines
+19
to
+20
| /** Start opting into the larger default height that will become the default size in a future version. */ | ||
| __next40pxDefaultSize = false, |
There was a problem hiding this comment.
Thought: instead of exposing __next40pxDefaultSize, could we instead just set __next40pxDefaultSize to true on NumberControl ? Or do we still care about offering consumers the option to opt-out of the new size, for the time being?
tyxla
approved these changes
Aug 16, 2024
This is kind of nuanced, more than the margin bottom prop, because until the entire Gutenberg UI is converted to the new sizes, we can't really say to the public that they should convert the size of x component already. This was even more so when the sizes state of the Gutenberg UI was much more mixed than it is now. So I'm thinking of going in and documenting the prop on all the readmes (we're definitely ready for that now), but I don't want to put it as a default in the snippets until we start throwing deprecation warnings. And ideally that should happen all at once for all components in the system. |
|
Documented the prop on all relevant component READMEs in #64592 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #63871
What?
Add a lint rule to prevent people from introducing new usages of NumberControl that do not adhere to the new default size.
Testing Instructions
The lint error should trigger for violations as expected.