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

Prop Type Descriptions #37

Open
hipstersmoothie opened this issue Dec 6, 2018 · 2 comments · May be fixed by #52
Open

Prop Type Descriptions #37

hipstersmoothie opened this issue Dec 6, 2018 · 2 comments · May be fixed by #52
Labels
enhancement New feature or request

Comments

@hipstersmoothie
Copy link

hipstersmoothie commented Dec 6, 2018 •
edited

React docgen also parses descriptions of props. It would be really cool if Playroom could display this.

Ways to use:

  1. When autocompleting a prop playroom could show the description and allowed strings for each prop. Here is what it looks like in VSCode

screen shot 2018-12-06 at 1 07 09 am

  1. On hover you could display the same information. And even the type

screen shot 2018-12-06 at 1 10 08 am
@markdalgleish markdalgleish added the enhancement New feature or request label Dec 6, 2018
@hipstersmoothie
Copy link
Author

Example of what it would look like https://codemirror.net/demo/tern.html

I just spent a few hours trying to do this but:

  1. there is not code mirror support for it - you have to make a custom hint function
  2. the examples are not clear at all so I'm having trouble getting anything working. but it should be possible

@hipstersmoothie hipstersmoothie linked a pull request Mar 27, 2019 that will close this issue
Open
6 tasks
@bryce-larson
Copy link

This would help us get designers to use playroom.

Is this PR going to get merged in?
Is there a plug-in system coming?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Prop Descriptions hipstersmoothie/playroom
3 participants
@markdalgleish @hipstersmoothie @bryce-larson