search

recharts / recharts.org

The website
MIT License
38 stars 141 forks source link

Event Handler Functions aren't documented well #88

Open maybebored opened 5 years ago

maybebored commented 5 years ago

None of the charts or components event handlers are documented well. They accept functions but, information on how passed function is invoked is lacking.

joelbyrd commented 10 months ago

Bump. Is this being worked on? It's surprising there's such a huge miss in the documentation.

ckifer commented 10 months ago

Hi @joelbyrd - definitely not being worked on. The storybook is currently a better source of truth than the website. The function params have been undocumented since recharts was created and now are inherited legacy along with a lot of other things (current maintainers are different than the creators).

Generally, docs are something we've been working to improve via the storybook, but this is definitely a place that needs more detail. Please feel free to contribute if you'd like to get something specific in!