Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[charts] New HTML legend & styles #15733

Draft
wants to merge 86 commits into
base: master
Choose a base branch
from

Conversation

JCQuintas
Copy link
Member

NOTE: I'm currently duplicating logic between src/ChartsHtmlLegend and src/ChartsLegend.
The goal is to remove clutter. Eventually the original should be removed and the new one should take its place.

Testing code
    <ChartDataProvider
      height={300}
      width={300}
      series={[
        { type: 'line', label: 'Line 1', data: [10, 20] },
        { type: 'line', label: 'Line 2', data: [50, 40] },
        { type: 'bar', label: 'Bar 1', data: [10, 20] },
        { type: 'bar', label: 'Bar 2', data: [50, 40] },
        { type: 'scatter', label: 'Scatter 1', data: [{ id: 'A', x: 0, y: 0 }, { id: 'B', x: 1, y: 1 }] },
        { type: 'scatter', label: 'Scatter 2', data: [{ id: 'A2', x: 5, y: 1 }, { id: 'B2', x: 4, y: 1 }] },
        { type: 'pie', data: [{ id: 'A', value: 10 }, { id: 'B', value: 20 }] },
        { type: 'pie', data: [{ id: 'A2', value: 10 }, { id: 'B2', value: 20 }] },
      ]}
    >
      <ChartsSurface />
      <ChartsLegend />
    </ChartDataProvider>

@JCQuintas JCQuintas added breaking change new feature New feature or request component: charts This is the name of the generic UI component, not the React module! v8.x labels Dec 4, 2024
@JCQuintas JCQuintas self-assigned this Dec 4, 2024
@mui-bot
Copy link

mui-bot commented Dec 4, 2024

Deploy preview: https://deploy-preview-15733--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 2aca38b

@JCQuintas
Copy link
Member Author

@alexfauquette Do we still want to provide slots.legend?

For slotProps it makes sense, but if we want to say that composition is the main way to customise items it might be good to remove it as well 🤔

@alexfauquette
Copy link
Member

Do we still want to provide slots.legend?

For me the main reason is "It's easier to be consistent than to explain edge cases". For each slot "xxx" we provide slots.xxx/slotProps.xxx. Would be surprising that we only provide the slotProps.

What would be the issue with providing a slots.legend? For me it could be done in a similar way than the slots.tooltip. A slot that get no prop and just allow user to pass the legend if it's the only thing they want to update

@JCQuintas
Copy link
Member Author

@alexfauquette no specific reason, it was just a question that occurred to me 😅

I agree with your points 👍

@JCQuintas
Copy link
Member Author

Do we still want to provide slots.legend?

For me the main reason is "It's easier to be consistent than to explain edge cases". For each slot "xxx" we provide slots.xxx/slotProps.xxx. Would be surprising that we only provide the slotProps.

What would be the issue with providing a slots.legend? For me it could be done in a similar way than the slots.tooltip. A slot that get no prop and just allow user to pass the legend if it's the only thing they want to update

I do think however, as we allow more customisation and hooks, we should drop slots/slotProps at one point, as it makes the code much more obnoxious than it needs be.

@alexfauquette
Copy link
Member

I do think however, as we allow more customisation and hooks, we should drop slots/slotProps at one point, as it makes the code much more obnoxious than it needs be.

I still see some interest to it. For example you use color scale and then need a special legend. It's nice to still have something like this instead of being forced to go full composition.

<BarChart
	{...my config}
	slots={{ legend: ChartColorMapLegend }}
/>

But yes it's something we could consider during the next major. Depending on the users feedback

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Dec 11, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change component: charts This is the name of the generic UI component, not the React module! new feature New feature or request v8.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants