Prop descriptions from a Flow codebase does not show up in prop table
See original GitHub issueDescribe the bug I expect that the comments above the props from a code base using Flow would show up in the prop table in Storybook.
To Reproduce Steps to reproduce the behavior:
- Install code from https://github.com/lifeofmle/storybook-flow
- Run
yarn install
- Run
yarn storybook
- Open Docs panel of Button component
Expected behavior I expect that the comments above the props would show up in the prop table in Storybook
Screenshots Here is a screenshot of the Docs generated without the description from Flow props
Code snippets I expect that the comments above the props would show up in the prop table in Storybook
type PropsType = {
/**
* Content of the button
*/
children: ?Element<*>;
/**
* Specifies the width of the button. Default 100%
*/
width: string;
/**
* What happens when you click on the button
*/
onClick: () => void;
}
System: Code available https://github.com/lifeofmle/storybook-flow
Assumption Storybook book would read the props similar to how Styleguidist therefore the comments would be read and displayed
Issue Analytics
- State:
- Created 4 years ago
- Comments:8 (6 by maintainers)
Top Results From Across the Web
Prop table doesn't show all the props in 5.3 #9764 - GitHub
Describe the bug While using v5.3.12, preset-create-react-app & TypeScript, I have a problem with the props table.
Read more >General question about prop.table function in R - Stack Overflow
No, there's no way to edit the prop.table function to give you your desired result. If you want the sum of your percentages...
Read more >JSDoc Reference - TypeScript: Documentation
JSDoc Reference. The list below outlines which constructs are currently supported when using JSDoc annotations to provide type information in JavaScript files.
Read more >Google TypeScript Style Guide
Editors display the description on constructor calls and property accesses. /** This class demonstrates how parameter properties are documented. */ class ...
Read more >Getting Started - Mithril
This function initializes the vm object with three members: list , which is simply an array, description , which is an m.prop getter-setter...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@patricklafrance Nope, that upgrade is still sitting in a PR. I’m guessing it was a
node_modules
issue in @lifeofmle 's repo?@patricklafrance @shilman With
5.3.0-rc.7
the props started working for my internal library that is using flow.It still doesn’t work with this demo project. I have no clue why.
I think it is safe to close this issue because it is working on my real code