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

Event Handler Functions aren't documented well #88

Open
maybebored opened this issue Jun 11, 2019 · 2 comments
Open

Event Handler Functions aren't documented well #88

maybebored opened this issue Jun 11, 2019 · 2 comments

Comments

@maybebored
Copy link

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
Copy link

joelbyrd commented Nov 2, 2023

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

@ckifer
Copy link
Member

ckifer commented Nov 2, 2023

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants