DataViews: Add types to the ViewGrid component #61667
Merged
Conversation
This file contains hidden or 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
youknowriad
added
[Type] Code Quality
|
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. |
youknowriad
commented
May 14, 2024
| className="dataviews-view-grid__title-actions" | ||
| > | ||
| <SingleSelectionCheckbox | ||
| id={ id } |
Contributor
Author
There was a problem hiding this comment.
I found that this prop was useless thanks to the types.
youknowriad
commented
May 14, 2024
| spacing={ 2 } | ||
| wrap | ||
| align="top" | ||
| alignment="top" |
Contributor
Author
There was a problem hiding this comment.
I think this was a bug also discovered thanks to the types.
|
Size Change: -2 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
youknowriad
force-pushed
the
add/view-grid-types
branch
from
aac185b to
7ae829d
Compare
sirreal
approved these changes
May 15, 2024
| /** | ||
| * The fields to use as columns. | ||
| */ | ||
| columnFields: string[]; |
Member
There was a problem hiding this comment.
This is strictly informational - no changes requested.
I like to use the readonly types where they make sense, for example:
Suggested change
| columnFields: string[]; | |
| columnFields: ReadonlyArray< string >; |
It's largely the same, except it clearly indicates the array isn't intended to be modified, so things like columnFields.pop() wouldn't be allowed.
I don't know how much that makes sense here, but much of our code avoids mutation and this is a way to clearly express (and enforce!) that.
Note that it's probably most helpful on function parameters (or constants):
// This function accepts regular and readonly arrays. Regular arrays satisfy readonly.
// it's easy to use and we know it won't modify the array internally
function sum(ns: ReadonlyArray<number>): number { return ns.reduce((a, b) => a + b, 0); }
// This function is trickier, we probably shouldn't care about returning readonly.
// Callers should be able to do what they want!
function split(s: string): ReadonlyArray<string> { return s.split(''); }
Contributor
Author
There was a problem hiding this comment.
For me I'd prefer to avoid this here because it will create inconsistencies. Most of the types are should be "Readonly" types.
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.
Related #55083
Follow-up to #61185
What?
The DataViews package is a types heavy package. There's a lot of structures that need to be documented properly. So this continues the effort to add explicit types to the package. This PR focuses on typing the ViewGrid component.
Testing instructions
There's no functional change, it's essentially a code quality + documentation change.