Where can I find the documentation of props?

[emil-alexandrescu]

Thanks for providing nice framework. I was going to give it a shot on a testing project, but I couldn't find any documentation of props for certain components.

[prehnRA]

Right now the only source for that are the examples, though they aren't guaranteed to be exhaustive of all the options.

We've looked at a variety of ways to do this, but unfortunately React doesn't give an easy way to introspect these automatically (to build documentation from prop types). Options we're considering:

• just build prop type documentation for each component manually
• use ESDoc to document the props as arguments to the component method or constructor
  • we could then have an API documentation section of the doc site with this info
  • ESDoc tools can also dump JSON format so in theory we could then automatically excerpt that into the example pages
• built typescript and/or flow type annotations for all the components, which provide better facilities for introspecting this information automatically (and enable useful type analysis during development)

We'd be open to any opinions on which path to pursue, and would welcome any prototype PRs trying out one of these approaches.

[jwietelmann]

@emil-alexandrescu Just an update: Work is underway to add tables of props to every documentation page. If you're interested, the tickets are here: https://github.com/revelrylabs/harmonium/issues?q=is%3Aissue+is%3Aopen+label%3Adocs

I think at the moment we might just be manually adding these rather than attempting to generate them. Anyway, given that we have a lot of individual tickets tracking this issue, I'm going to close this general one in favor of those.