[charts][docs] Document sparkline color modification

[alexfauquette]

Feedback received:

how to change line chart color?

from https://mui.com/x/react-charts/sparkline/#

Search keywords:

[alexfauquette]

Posiible options:

• Modify spark line such that a color props get propagated
• first one is the hack of using colors=["red"] https://mui.com/x/react-charts/sparkline/#y-axis-range
• Override CSS https://mui.com/x/react-charts/styling/#css (this one could lead to some edge cases issues)

[bernardobelchior]

Given that using the colors prop is possible, does it make sense to also have a color prop? It seems that it would allow us to achieve the same result through two different paths.

From my investigation, it seems the colors prop makes sense in the context of non-sparkline charts because they can have more than one series. However, since sparkline only supports a single series, does it make sense to allow a colors prop at all?

My suggestion would be adding a color prop, but remove (or at least deprecate) the colors prop to ensure there is no confusion. What are your thoughts? Is there any downside that I might be missing?

[alexfauquette]

The proposal looks good. We can start by deprecating. having both is not a big issue.

To deprecate a props in the TypeScript JSDocs you can add @deprecated you will find other example in the codebase

[github-actions]

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.