search

woven-planet / lakefront

Lakefront project
9 stars 3 forks source link

Allow viewing nested types/interfaces #148

Open jason-ransom-slalom opened 2 years ago

jason-ransom-slalom commented 2 years ago

As a user I would like to view documentation on the types/interfaces used in Lakefront. The storybook documentation in lakefront currently shows the name of types/interfaces, but how the types/interfaces are actually structured is not available without going into the source code.

An example of this is the lack of documentation on what the structure of a SelectPopoverOption should be when checking out the SelectPopover docs.

jason-ransom-slalom commented 2 years ago

It appears this is a storybook addon-docs feature that has been requested. In order to properly implement this feature, one or more of the below issues will need to be resolved with features added:

Related Issues on Github In the description column in the ArgsTable, view properties of TypeScript types like an interface, enum, etc.: https://github.com/storybookjs/storybook/issues/13459 Addon-docs: Proposal to link interfaces: https://github.com/storybookjs/storybook/issues/7944 Addon-docs: Auto-generated tables for Typescript interfaces: https://github.com/storybookjs/storybook/issues/15008 Info Addon - Props table when using nested types with react-docgen-typescript-loader : https://github.com/storybookjs/storybook/issues/7661