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

Addon-docs: Auto-generated tables for Typescript interfaces #15008

Open
shilman opened this issue May 22, 2021 · 5 comments
Open

Addon-docs: Auto-generated tables for Typescript interfaces #15008

shilman opened this issue May 22, 2021 · 5 comments

Comments

@shilman
Copy link
Member

shilman commented May 22, 2021

Currently, we auto-generate ArgsTables for components based on their Typescript signatures.

It would be useful to automatically create ArgsTable-style documentation for ANY typescript interface.

Something like:

<InterfaceTable of={MyInterface} />
@YozhEzhi
Copy link
Contributor

YozhEzhi commented May 27, 2021

It would be great!

I have this interfaces like ISource[]:

image

And for now I don't know how to deal with this (how to print description for that ISource[]).

I bet on <InterfaceTable of={ISource} />!

BTW. Some packages has types only (type utils). So InterfaceTable would deal with that.

@jason-ransom-slalom
Copy link

It would be great!

I have this interfaces like ISource[]:

image

And for now I don't know how to deal with this (how to print description for that ISource[]).

I bet on <InterfaceTable of={ISource} />!

BTW. Some packages has types only (type utils). So InterfaceTable would deal with that.

^ Agreed!

@ChazUK
Copy link

ChazUK commented Mar 11, 2022

This would be great for interfaces and types!

@jpiazzal
Copy link

I just started to write a storybook addon to do this (it can be found here).
For now it support only interfaces but more types will be available soon. Feel free to send me any feedback or to open issues

@shilman shilman removed the todo label Jun 20, 2023
@Dina-Lai
Copy link

Dina-Lai commented Sep 5, 2023

I really need this!

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

6 participants