[TypeScript] Fix Button component props accepts a record #7764
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
slax57
approved these changes
May 30, 2022
Comment on lines
-68
to
+74
| export type ShowButtonProps = Props & ButtonProps; | ||
| export type ShowButtonProps<RecordType extends RaRecord = any> = Props< | ||
| RecordType | ||
| > & | ||
| ButtonProps; |
There was a problem hiding this comment.
EditButton also has MuiButtonProps allowed. Should we add them here as well? (although I agree this is beyond the scope of the problem solved by this PR)
There was a problem hiding this comment.
ButtonProps already extends MuiButtonProps
djhi
requested changes
May 30, 2022
fzaninotto
changed the title
djhi
requested changes
May 30, 2022
| @@ -61,12 +56,12 @@ const sanitizeRestProps = ({ | |||
| }: Omit<CloneButtonProps, 'label' | 'scrollToTop' | 'icon'>) => rest; | |||
|
|
|||
| interface Props { | |||
| record?: Partial<RaRecord>; | |||
| record?: any; | |||
There was a problem hiding this comment.
We should probably prefer Record<string, unknown> instead of any. Same everywhere we accept a RecordType
There was a problem hiding this comment.
here, we used to accept a Partial<RaRecord>, which is indeed any
There was a problem hiding this comment.
We should fix that everywhere in a dedicated PR. Passing a number as record does not make sense for instance
djhi
approved these changes
May 30, 2022
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.
Problem
The
<Button>component accepts arecordprop for historical reasons (it used to be injected by the Toolbar), but it doesn't make sense since it is purely a presentational component and it can be used outside of a Record context (e.g. for list view buttons)Solution
Remove the
recordprop from the<Button>component, and re-add it to the descendants of<Button>that require it.