Storybook: addon-info: Add support for Vue

Created on 23 Jan 2018  路  29Comments  路  Source: storybookjs/storybook

Issue details

This issue is feature request for adding support Vue component on @sotrybook/addon-info

Details

In authoring reusable Vue component, types of documentation that need to be added:

One example in this readme


Also, it would be nice if there is feature for choosing which component to be documented, something like

withInfo({ component: MyComponent })(() => /** story */)

Additional

Currently, I'm using storybook to showcase a Vue component in mvce style like in here.
Because it's more comfortable writing scenario/use-case in .vue SFC format, so I implement it via this way:

  1. register each scenario as story element-tag
  2. write scenarios in .vue SFC format
  3. register my reusable component on each scenario

In short:
src/stories/index.js <- src/stories/story/Scenario.vue <- src/components/MyComponent.vue

info vue feature request inactive

Most helpful comment

馃憤 . storybook-addon-vue-info doesn't play nicely with non-component tags, nor decorators.

All 29 comments

+1, this would be great

Not, closing!!!

1501 should probably be done before adding support for more frameworks

I would imagine info support for vue to be in a new addon instead of adding it to the existing info addon. There are some pretty significant differences between the two frameworks that I think it justifies splitting them.

Splitting the package into react, vue, angular can reduce the code complexity
import { withInfo } from '@storybook/addon-info/vue'
import { withInfo } from '@storybook/addon-info/react'
import { withInfo } from '@storybook/addon-info/angular'

Not the author, but just wanted to say that this exists and seems to be being actively developed: https://github.com/pocka/storybook-addon-vue-info

https://github.com/pocka/storybook-addon-vue-info this's useful, but not enough.

馃憤 . storybook-addon-vue-info doesn't play nicely with non-component tags, nor decorators.

bump

bump

Linking with #4770.
You can use https://github.com/pocka/storybook-addon-vue-info.
Update: Also it's mentioned in the comments above 鈽濓笍

Any plans to add support for Vue?

Hi there ! any plans, release date to add support for Vue ?

Seems there is no work in progress for this feature (waiting for Vue v3?). I wonder how the vue storybook will differ from https://vueds.com 馃

Thanks for the share @DrSensor, I will take a look !!

I have a working prototype for Vue and will be shipping this out in the 5.x cycle. For more information see the RFC and a short demo:

RFC: https://docs.google.com/document/d/1D4Ov4UvrB80Uy1CLGshbFEWQKWEpr8dL4FmOqRDwjwI/edit?usp=sharing
Demo: https://twitter.com/mshilman/status/1113532547764342784

@shilman, can't wait !!

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

@probot waiting for v5.x

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

Is there anything going on actually? Aren't we in a 5.x yet?

@forforeach Vue is supported in the addon-docs technical preview including props, source, docgen info, notes, etc.

https://docs.google.com/document/d/1un6YX7xDKEKl5-MVb-egnOYN8dynb5Hf7mq0hipk8JE/edit?usp=sharing

image

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

@probot waiting for the sneak peek

@DrSensor why wait, it's been available in alpha for over a month?

Wait what..., yeah 馃拑 will take a 馃憖

@DrSensor Feel free to join in the conversation on #docs-mode in our discord https://discord.gg/UUt2PJb

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

Hey there, it's me again! I am going close this issue to help our maintainers focus on the current development roadmap instead. If the issue mentioned is still a concern, please open a new ticket and mention this old one. Cheers and thanks for using Storybook!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

miljan-aleksic picture miljan-aleksic  路  3Comments

shilman picture shilman  路  3Comments

ZigGreen picture ZigGreen  路  3Comments

purplecones picture purplecones  路  3Comments

tirli picture tirli  路  3Comments