[docs] Specify that dialogs payload is not restricted to string type #4373
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
Janpot
reviewed
Nov 6, 2024
| @@ -8,7 +8,7 @@ import DialogActions from '@mui/material/DialogActions'; | |||
| import TextField from '@mui/material/TextField'; | |||
| import Stack from '@mui/material/Stack'; | |||
|
|
|||
| function MyCustomDialog({ payload, open, onClose }: DialogProps<string>) { | |||
| function MyCustomDialog({ payload, open, onClose }: DialogProps<any>) { | |||
There was a problem hiding this comment.
no, we need to advertise strong typing. this is what makes it safe to use.
Suggested change
| function MyCustomDialog({ payload, open, onClose }: DialogProps<any>) { | |
| function MyCustomDialog({ payload, open, onClose }: DialogProps<string>) { |
|
I think we need to add an example that makes this advanced usage clear. It will demonstrate how different form components can be passed to the same dialog component through the We can add it to an "Advanced" section in the dialog docs page or create a Recipes page and move this there. What do you think about that? |
The advanced example demonstrates this very well.👍 Thanks for adding it. Feel to close this PR when the other one is approved. |
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.
No description provided.