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

Sync Component Property Documentation #226

Open
lukask-proxora opened this issue Dec 30, 2022 · 1 comment
Open

Sync Component Property Documentation #226

lukask-proxora opened this issue Dec 30, 2022 · 1 comment

Comments

@lukask-proxora
Copy link
Contributor

lukask-proxora commented Dec 30, 2022

The documentation of the component props is outdated. It probably makes sense to go over every component and sync the actual props in the code with the docs.

For each component it should be checked:

  • if there are new props in code that are not documented yet
  • if there are deprecated props that do not exist anymore in code
  • if isOpional, type, defaultVal in the docs are set correctly

This will probably resolve several other issues.

@ckifer
Copy link
Member

ckifer commented Dec 30, 2022

Note to whoever takes this: the types for the component props mostly extend SVGProps which allow a TON of properties to be able to be passed down to the graphical children. We want to first document all of the actual properties on each graphical child like these and then need to discuss these property extensions

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

2 participants