-
Notifications
You must be signed in to change notification settings - Fork 139
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
update Tooltip docs #47
Conversation
…m-LineChart Add HighlightAndZoomLineChart Example in LineChart
Add missing startAngle endAngle prop in RadialBarChart
Add documentation for the arbirary domain changes
…der-order feat: adds documentation for reverseGroupOrder, fix #873
…w-wording Clarify wording of allowDataOverflow description
Update Line.js
feat: Add DoubleAreaChart example
What's confusing to me is that the docs mix together two things:
Granted, there is a lot of overlap between these, but not entirely, because recharts calculates a lot of stuff for you and you can't actually directly configure it for the tooltip ( I think this PR is good in the sense that it adds some of the attributes that recharts gives to the custom tooltip component within the |
In other words, the docs are not distinguishing between props you give to recharts vs. props you get from recharts. |
You make a good point. If there is any guidance on how these items are calculated and when they can be expected to be available I'd happily write it up in more detail. My knowledge thus far has come from examining the code at length until I could figure out what was going on. That is certainly error prone at best. |
Thanks for all your suggestion! In my opinion, show all the |
I've been having a lengthy discussion with the definitely typed team about adding these attributes. They understandably are hesitant to add undocumented types. Since the underlying code base makes use of these types, and they are useful when creating a custom tooltip, they should be documented.
See the PR on definitely typed here
I also opened an issue on the recharts main repo here