How to display state properties of a react component

[amittkSharma]

Hello Team,

I am working with Storybook and using the info Addon for displaying the properties of the component in the story. And I wanted to display the state properties of the component too.

1. Is there some way I can use the same addon to display the state properties of the component?
2. Or there is some other addon I have to use for this purpose?

Thanks in advance.
Amit

[Keraito]

Hey @amittkSharma, what properties of the state do you exactly want to display?

The reason that the addon-info can display the additional information of the properties of components is cuz they are statically defined. As far as I'm aware, that is rarely to not done for the state of react components. Or are you referring to different information?

[amittkSharma]

Hi Keraito,

Thanks for the response, but the thing I am referring is some kind of state interface that a react component has? This will be useful for the user using the storybook to get the information that what kind of state a component will be maintaining.

Thanks
Amit

[wuweiweiwu]

Hi @amittkSharma,

The info addon currently uses the parse tree via babel plugin to generate docs. However, state documentation is not supported unless you just want to use withInfo. Perhaps in the future we can support flow annotations on state type definitions.

[amittkSharma]

Thanks, looking forward to the feature in the addon.

[wuweiweiwu]

For now, if you want to document state it'll prob be just just to write it out. 👍