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: Generalize DocsPage prop tables #8123

Closed
shilman opened this issue Sep 19, 2019 · 5 comments
Closed

Addon-docs: Generalize DocsPage prop tables #8123

shilman opened this issue Sep 19, 2019 · 5 comments

Comments

@shilman
Copy link
Member

shilman commented Sep 19, 2019

Storybook's prop tables were written with React in mind, which only has the concept of props.

We should generalize DocsPage to support these different component inputs/outputs.

@alexlafroscia
Copy link

alexlafroscia commented Sep 19, 2019

Just to add additional use-case ideas and make the need explicit, Web Components (which I have been using through the html support in Storybook) might want to document:

  • Props
  • Attributes (often overlapping with Props, but not always)
  • Slots
  • Events
  • CSS variables

You can get an idea of how this is being used right now here: #4600 (comment)

@raihle
Copy link

raihle commented Sep 23, 2019

For Vue (dunno about Angular or other frameworks) it would also be interesting to support methods. E.g. https://buefy.org/documentation/collapse#api-view

@shilman
Copy link
Member Author

shilman commented Oct 25, 2019

Whoopee!! I just released https://github.com/storybookjs/storybook/releases/tag/v5.3.0-alpha.28 containing PR #8489 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

Closing this issue. Please re-open if you think there's still more to do.

@shilman
Copy link
Member Author

shilman commented Oct 25, 2019

Yowza!! I just released https://github.com/storybookjs/storybook/releases/tag/v5.3.0-alpha.29 containing PR #8567 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

@shilman
Copy link
Member Author

shilman commented Oct 30, 2019

Son of a gun!! I just released https://github.com/storybookjs/storybook/releases/tag/v5.3.0-alpha.34 containing PR #8632 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

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

3 participants