fix(14831): update component and getter function types to match #17135
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
Update <TableExpandRow />, <TableSelectAll />, <TableSelectRow /> props to make checked and isSelected nullable since they already expect undefined or default to a boolean value anyway. This allows the values returned by getSelectionProps and getRowProps to be more consistent. This should resolve typescript errors that occur when using official examples.
|
All contributors have signed the DCO. |
|
I have read the DCO document and I hereby sign the DCO. |
✅ Deploy Preview for v11-carbon-react ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for carbon-elements ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
tay1orjones
approved these changes
Oct 28, 2024
…831-datatable-type-fixes
✅ Deploy Preview for v11-carbon-web-components ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
tay1orjones
approved these changes
Oct 28, 2024
|
There must've been some overlap with another PR. When I updated this with latest from |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #17135 +/- ##
=======================================
Coverage 80.79% 80.79%
=======================================
Files 406 406
Lines 14041 14041
Branches 4367 4395 +28
=======================================
Hits 11344 11344
Misses 2530 2530
Partials 167 167 ☔ View full report in Codecov by Sentry. |
Merged
via the queue into
carbon-design-system:main
with commit Oct 29, 2024
538060f
40 checks passed
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.
Update
<TableExpandRow />,<TableSelectAll />,<TableSelectRow />props to make checked and isSelected optional since they already expect undefined or default to a boolean value anyway. This allows the values returned by getSelectionProps and getRowProps to be more consistent. This should resolve typescript errors that occur when using official examples.Closes #14831
Making the argument for
getSelectionPropsoptional allows the official examples to work without breaking anything with the change; the function already defaults the argument to an empty object. There is perhaps something to be said for refactoring thegetSelectionPropsfunction to better differentiate between the contexts in which it is used (<TableSelectRow />vs<TableSelectAll />), but the presence of an optional argument (as it is now) seems reasonable.Switching the
onClickhandlers to use React'sMouseEventinterface makes them compatible withMouseEventHandler<HTMLButtonElement>, which resolves a few of the errors on those components.The
checkedprop was overly restrictive in the<TableSelectRow />and<TableSelectAll />prop definitions; the only places the prop is used within those components expects it to be optional. Relaxing the type on those two components resolves the typescript errors and seems to have been the original intent based on how it is typed inDataTableRow. This shouldn't be a breaking change to the component API since all currently allowed values are still valid after the change. TheisExpandedprop on<TableExpandRow />is the same issue of being overly restrictive.The
radiokey being returned fromgetSelectionPropsunnecessarily included anulloption - both the actual value and the type. Removing both references tonullmakes it compatible with<TableSelectRow />props.Changelog
New
Changed
onClickhandlers now use React'sMouseEventinterface instead of the nativeMouseEventgetSelectionPropsarguments are now optionalgetSelectionPropsis now accurately typed to returncheckedas an optional keygetSelectionpropsradiokey is nowboolean | undefined(changed fromboolean | undefined | null)<TableSelectRow />and<TableSelectAll />checkedprop is now optional<TableExpandRow />isExpandedprop is now optionalRemoved
Testing / Reviewing
Run the code examples for
DataTable / Selection / DefaultandDataTable / Expansion / Defaultin a TypeScript environment; the errors should be resolved.