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.

Sign up for GitHub

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

Jump to bottom

In the description column in the ArgsTable, view properties of TypeScript types like an interface, enum, etc. #13459

Open
iamtomhanks opened this issue Dec 15, 2020 · 3 comments
Open

In the description column in the ArgsTable, view properties of TypeScript types like an interface, enum, etc. #13459

iamtomhanks opened this issue Dec 15, 2020 · 3 comments
Labels
addon: docs block: argstable feature request typescript

Comments

@iamtomhanks
Copy link

iamtomhanks commented Dec 15, 2020 •
edited
Loading

For example, if a component accepts a props user, which is of type User, where I have defined a User interface. Below is the resulting output:
Screen Shot 2020-12-15 at 2 28 21 PM

If I am a stakeholder, I want a way to see what properties the user object can have. Maybe if I hover over User under the description column, I can view the interface.

Another request would be to have a control for easily editing nested object properties, instead of the plain-text JSON. But that is a separate feature request that I think is already open.
@iamtomhanks iamtomhanks changed the title In the description column in the ArgsTable, view properties of TypesScript types like an interface, enum, etc. In the description column in the ArgsTable, view properties of TypeScript types like an interface, enum, etc. Dec 15, 2020
@radomskip
Copy link

It would be great to have this feature!!!!

@jason-ransom-slalom
Copy link

It would be great to have this feature!!!!

^ Agreed!

@jason-ransom-slalom jason-ransom-slalom mentioned this issue Aug 23, 2021
Open
Open
@dcantu96
Copy link

dcantu96 commented May 3, 2022

is there any update on this feature? this would be really great to have!

@shilman shilman removed the P2 label Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
addon: docs block: argstable feature request typescript
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@shilman @iamtomhanks @dcantu96 @radomskip @jason-ransom-slalom