Storybookでコンポーネントカタログを作る

Storybookを利用することで、プロジェクトで作成したコンポーネントのカタログを作ることができます。
どういうコンポーネントかも視覚的にわかりドキュメントとしていいものになると思います。

今回は、vue.jsでStorybookを利用してみます。
※他にもAnguler,Reactでも利用できますが利用方法については、Storybookガイドを参照してください。

前提

vue.jsプロジェクトについては、vue-cliを使ってvue.jsを使ったプロジェクトの開発環境を整えるの通りvue-cliを使用し、webpackテンプレートを使用して作成したものとします。

環境

項目 バージョン
node 9.11.1
vue-cli 2.9.3
vue.js 2.5.2
storybook 3.4.6

Storybookを導入

StorybookのガイドのQuick Start Guideにある通りgetstorybookを利用します。

getstorybookが完了すると、以下にディレクトリが追加されています。

ディレクトリ 説明
.storybook StorybookのConfigディレクトリ
src/stories 各storyディレクトリ

getstorybookで導入すると、index.stories.jsの記述が原因で起動時にエラーが発生します。
そのため、issues:2727に記載の通り以下の記述を削除する必要があります。

Storybook起動

起動にはnpm scriptとして追加されているstorybookを利用します。

起動すると、http:localhost:6060にアクセスしてみてください。

storybook welcome

getstorybooksrc/storiesに作成されているstoryが表示されます。
これで、導入は完了です。

コンポーネントのstoryを作成

getstorybookで作成されたsrc/stories以下の各ファイルは不要なので削除し、.stories.jsで終わるファイルを作成します。
そして、storiesOfの第1引数にストーリーグループ名を入力します。
続けて、add関数で追加したいコンポーネントのstoryを記述します。

以下はSampleButtonコンポーネントのstoryを記述している例です。
Buttonグループにデフォルトの表示と、デフォルトサイズとFullサイズの違いを確認できるようにしました。

  • index.stories.js
  • SampleButton.vue

Storybook SampleButton

スポンサーリンク
  • このエントリーをはてなブックマークに追加
  • Evernoteに保存Evernoteに保存
スポンサーリンク

コメントをどうぞ

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA