search

pocka / storybook-addon-vue-info

Info addon for Vue components
https://storybook-addon-vue-info.netlify.com/?path=/story/examples-basic-usage--simple-example
MIT License
164 stars 28 forks source link

Feature Request: SlotDescriptions (just like propDescriptions) #106

Closed Xayer closed 5 years ago

Xayer commented 5 years ago

Is your feature request related to a problem? Please describe. No

Describe the solution you'd like Same functionality as propDescriptions, but for slots. eg. slotDescriptions.

Describe alternatives you've considered None.

Additional context None.

pocka commented 5 years ago

I opened a PR that adds description option for stories. What do you think about it? I'd like to hear opinions from who uses propsDescription!

Xayer commented 5 years ago

@pocka I realized that I could use code comments on the props, and achieve the same result. The description object you have made in the PR should solve that 😍!

pocka commented 5 years ago

Yeah, you can add description for slots by using slot comments with vue-docgen-api. I'll merge the PR so to non docgen-users can do this then add documentation about slot comments.

pocka commented 5 years ago

Released in v1.3.0