[charts] Improve dataset typing #11372
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
alexfauquette
added
the
component: charts
|
Deploy preview: https://deploy-preview-11372--material-ui-x.netlify.app/ |
3 tasks
LukasTy
approved these changes
Dec 14, 2023
There was a problem hiding this comment.
It's a nice improvement! 🙌
<...> I'm wondering if the default type should be unknown such that they can put whatever they want in the dataset, and do stricter type-checking into formatters
That's a very valid proposition. 👍
However, do you feel it is a problem now?
Because if it's not, then maybe we can wait for community confirmation (request for it) on this regard?
It should be too hard making the types more loose—possibly not a breaking change. 😃
| import defaultizeValueFormatter from '../internals/defaultizeValueFormatter'; | ||
| import { DefaultizedProps } from '../models/helpers'; | ||
|
|
||
| let warnOnce = false; |
There was a problem hiding this comment.
Suggested change
| let warnOnce = false; | |
| let warnedOnce = false; |
| if (process.env.NODE_ENV !== 'production' && !warnOnce && value !== null) { | ||
| warnOnce = true; | ||
| console.error([ | ||
| `MUI-X charts: your dataset key "${dataKey}" is used for plotting line, but contains non number elements.`, |
There was a problem hiding this comment.
Suggested change
| `MUI-X charts: your dataset key "${dataKey}" is used for plotting line, but contains non number elements.`, | |
| `MUI-X charts: your dataset key "${dataKey}" is used for plotting line, but contains nonnumerical elements.`, |
| if (process.env.NODE_ENV !== 'production' && !warnOnce && value !== null) { | ||
| warnOnce = true; | ||
| console.error([ | ||
| `MUI-X charts: your dataset key "${dataKey}" is used for plotting bars, but contains non number elements.`, |
There was a problem hiding this comment.
Suggested change
| `MUI-X charts: your dataset key "${dataKey}" is used for plotting bars, but contains non number elements.`, | |
| `MUI-X charts: your dataset key "${dataKey}" is used for plotting bars, but contains nonnumerical elements.`, |
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.
When working on mui/material-ui#40107 I noticed
nullwas not accepted as a data set value. This PR fixes this issue by allowingnullandundefined.On a larger topic, I think devs tend to put various things in the dataset. The result of their data fetching without preprocessing to enable rich tooltip for example. I'm wondering if the default type should be
unknownsuch that they can put whatever they want in the dataset, and do stricter type-checking into formatters