[charts] Pass all props to legend #14392
Conversation
JCQuintas
added
docs
|
Deploy preview: https://deploy-preview-14392--material-ui-x.netlify.app/ |
CodSpeed Performance ReportMerging #14392 will not alter performanceComparing Summary
|
| /** | ||
| * Set to true to hide the legend. | ||
| * @default false | ||
| */ | ||
| hidden?: boolean; |
There was a problem hiding this comment.
Make me think that this hidden and the early return null associated would better fit in the parent components to do not compute item placement if the legend is hidden
| import { DefaultizedProps } from '../models/helpers'; | ||
| import { DefaultChartsLegend, LegendRendererProps } from './DefaultChartsLegend'; | ||
| import { useDrawingArea } from '../hooks'; | ||
| import { useSeries } from '../hooks/useSeries'; | ||
| import { LegendPlacement } from './legend.types'; | ||
|
|
||
| export type ChartsLegendPropsBase = Omit< | ||
| LegendRendererProps, | ||
| keyof LegendPlacement | 'series' | 'seriesToDisplay' | 'drawingArea' |
There was a problem hiding this comment.
Was this intended to make seriesToDisplay an invalid key to BarChart.slotProps.legend ?
Edit: Looks like an issue is already open for this: #14561
There was a problem hiding this comment.
It was intentional for the ChartsLegendPropsBase because those props are also used for color map legends
But not sure it was intentional for the slot to lose it @JCQuintas can you confirm?
There was a problem hiding this comment.
🤔 It wasn't intentional, but I expected our type generating scripts to pick it up 😓
As part of #14231 I've noticed some props weren't properly documented nor passed to the components.
Allowing these props should make small adjustments simpler for the user.
Also made prop inheritance a bit simpler
As opposed to previously where