一、简介

　　Storybook是一款开源的组件开发工具，它可以运行在主程序之外，因此开发者可以用它来独立开发UI组件，或者用它来快速构建ui组件文档。

　　目前Storybook支持的框架有：

• React
• React Native 
• Vue
• Angular
• Marionette.js
• Mithril
• Marko
• HTML
• Svelte
• Riot
• Ember
• Preact
• Rax

　　可以看到，Storybook的功能是相当丰富的。本文将以Vue为例，从零开始搭建一个自己的Storybook。

二、安装Storybook

　　首先自己创建一下文件夹，storybook-demo。

　　官方文档中给的安装方式有2种，第一种是自动化安装，有点类似vue的脚手架，它会自动将环境配置好，开发者无需手动初始化相关配置文件。

npx -p @storybook/cli sb init --type vue

　　第二种是可以手动进行配置，读者可以参照官网的教程来进行安装。附送地址：https://storybook.js.org/docs/guides/guide-vue/。

　　但是笔者经过尝试，使用官方的方法安装的时候会缺少部分依赖导致运行失败，下面将介绍一下笔者自己使用的安装方法。

　　首先，安装vue脚手架，然后初始化项目:

vue create storybook-demo

　　选择babel和css预处理， 并且在第三部选择安装node-sass，这几项是必须的，其他可根据需要进行选择。　　

　　脚手架安装完成后，删除无关文件，并在根目录下新建.storybook、stories文件夹，在.storybook下新建以下文件：addons.js、main.js、config.js、webpack.config.js。完成之后目录如下：

　　下面再进行storybook的相关安装。

　　安装storybook for vue:

npm install @storybook/vue --save-dev

　　在根目录下找到package.json文件并配置引导：

1{
2    "scripts": {
3      "storybook": "start-storybook"
4    }
5}

　　当然，你也可以在后面跟上-p port来设置默认端口号，如：

1{
2    "scripts": {
3      "storybook": "start-storybook -p 6006"
4    }
5}

　　在根目录下新建.storybook文件夹，并在里面新建main.js文件，进行相关配置：

module.exports = {

　　stories: ['../stories/**/*.stories.js', '../stories/*.stories.js']

};

　　这样系统就会自动解析src目录下的*.stories.js、*.stories.ts文件了。

　　之后，在根目录下新建src文件夹，在里面新建index.stories.js文件并编写自己的组件：

1import Vue from 'vue';
2import MyButton from './Button.js';
3
4export default { title: 'Button' };
5
6export const withText = () => '<my-button>with text</my-button>';
7
8export const withEmoji = () => '<my-button>😀 😎 👍 💯</my-button>';
9
10export const asAComponent = () => ({
11  components: { MyButton },
12  template: '<my-button :rounded="true">rounded</my-button>'
13});

　　Button.js（由于这里没有安装vue文件的解析依赖，所以只能用js文件来进行代替，如果想引入vue来代替js，可自行安装相关loader）:

1export default {
2  name: 'my-button',
3
4  data() {
5    return {
6      buttonStyles: {
7        border: '1px solid #eee',
8        borderRadius: 3,
9        backgroundColor: '#FFFFFF',
10        cursor: 'pointer',
11        fontSize: 15,
12        padding: '3px 10px',
13        margin: 10,
14      },
15    };
16  },
17
18  template: `
19    <button :style="buttonStyles" @click="onClick">
20      <slot></slot>
21    </button>
22  `,
23
24  methods: {
25    onClick() {
26      console.log('click');
27      this.$emit('click');
28    },
29  },
30};

　　这样，一个简单的storybook就搭建完成了。在命令行输入：

npm run storybook

　　就会自动打开刚才的storybook。

三、storybook的插件 - addons

　　通过上面的搭建可以看到，我们自己搭建的storybook与一开始的看到的图片简直就是买家秀和卖家秀的区别。这是因为在storybook中，它提供了很多插件供开发者使用，开发者可以使用addons给每个story增加额外的功能，如使用文档、查看源码、查看事件等，使每个story的功能更加丰富。

　　storybook自带的addons已足够使用，当然官方也提供了相关api可以让开发者编写自己的addon，具体实现可移步到官方文档中进行查看。

　　官方自带的addons可参考：

　　https://storybook.js.org/addons/

　　https://github.com/storybookjs/storybook/tree/master/addons

　　当然，使用addons之前必须先到https://github.com/storybookjs/storybook/blob/master/ADDONS_SUPPORT.md查看相关addon是否支持当前框架，比如说info插件就只支持react但是不支持vue，之前笔者还在这里研究了半天为什么info一直配置失败。

　　下面介绍几个笔者自己用过的addon以及配置方法，其他addon可照猫画虎，根据官方文档给的参数进行配置即可。

　　1. story-source - 查看当前story源码

　　安装：

npm i @storybook/addon-storysource --save-dev

　　配置：

　　.storybook/main.js

1const path = require("path");
2module.exports = {
3  stories: ["../stories/**/*.stories.js", "../stories/*.stories.js"],
4  addons: [
5    {
6      name: "@storybook/addon-storysource",
7      options: {
8        rule: {
9          // test: [/\.stories\.jsx?$/], This is default
10          include: [path.resolve(__dirname, "../stories")], // 找到自己存放stories的文件夹
11        },
12        loaderOptions: {
13          prettierConfig: { printWidth: 80, singleQuote: false },
14        },
15      },
16    },
17  ],
18};

　　其中，loaderOptions的默认值为：

1{
2  printWidth: 100,
3  tabWidth: 2,
4  bracketSpacing: true,
5  trailingComma: 'es5',
6  singleQuote: true,
7}

　　在.storybook/addons.js里面进行插件注册：

1import '@storybook/addons';
2import '@storybook/addon-storysource'

　　到这里就可以了，重新运行一下看一下结果：

　　2. readme - 当前组件的文档说明

　　安装：

npm install --save-dev storybook-readme

　　注册：

　　.storybook/addons.js

import 'storybook-readme/register';

　　配置：

　　这里可分为全局配置和局部配置，全局配置可以在.storybook/config.js里面进行相关配置，局部配置可在制定的*.stories.js文件里进行配置。区别如下：

　　全局配置需调用以下方法：

1import { addDecorator } from '@storybook/vue';
2import { addReadme, configureReadme } from 'storybook-readme';
3
4configureReadme({
5    // ...some code
6});
7
8addDecorator(addReadme);

　　局部配置：

1import { storiesOf } from "@storybook/vue";
2
3import MyButton from "./MyButton.vue";
4import ButtonReadme from "./MyButton.md";
5storiesOf("Demo", module)
6  .addParameters({
7    readme: {
8      codeTheme: "duotone-sea",
9      content: ButtonReadme,
10      sidebar: ButtonReadme,
11    }
12  })
13  .add("Button", () => {
14    return {
15      components: {
16        MyButton,
17      },
18      template: `<my-button type="primary">My Button</my-button>`,
19    };
20  });

　　由于这个addon是没有官方文档的，笔者花了好长时间才找到一个开源文档，可移步到https://github.com/tuchk4/storybook-readme进行参考，里面也有相关demo可以查看。

　　稍微解释一下里面各方法参数的作用：

1configureReadme({
2  /**
3   * Wrapper for story. Usually used to set some styles
4   * React: React.ReactNode
5   * Vue: Vue component
6   */
7  // 组件区域的预处理，相当于在组件展示的时候外面套上一层div，组件作为插槽插入到这个div里面，在这里可以设置div的样式，如果是使用vue的话可以以vue组件格式插入，下面同理
8  StoryPreview
9
10  /**
11   * Wrapper for content and sidebar docs. Usually used to set some styles
12   * React: React.ReactNode
13   * Vue: Vue component
14   */
15  // 文档部分的样式，即插件里面的content
16  DocPreview/**
17   * Wrapper for header docs. Usually used to set some styles
18   * React: React.ReactNode
19   * Vue: Vue component
20   */
21  HeaderPreview/**
22   * Wrapper for footer docs. Usually used to set some styles
23   * React: React.ReactNode
24   * Vue: Vue component
25   */
26  FooterPreview
27
28  /**
29   * Header docs in markdown format
30   */
31  header: '',
32
33  /**
34   * Footer docs in markdown format
35   */
36  footer: '',
37});

 　　不理解preview的可以看一下上图，比如header的内容就为“用户交互组件demo”，headerPreview就是下面那层border，如果有将readme注册到addons.js里面，在绿色方框里还会有一个readme选项，可以查看文档。

　　在给特定story添加readme的时候，可以看到可以添加两个文档，如：

1storiesOf("Demo", module)
2  .addParameters({
3    readme: {
4      codeTheme: "duotone-sea",
5      content: ButtonReadme,
6      sidebar: ButtonReadme,
7    }
8  })
9  .add("Button", () => {
10    return {
11      components: {
12        MyButton,
13      },
14      template: `<my-button type="primary">My Button</my-button>`,
15    };
16  });

　　其中，这里可能会有读者不理解。里面是content是对应图中红色方框的内容，sidebar则是对应绿色方框里的内容（如果有注册），codeTheme是md文档的样式，可自行设置。

　　这里还有一个小技巧，就是在编写content的时候，可以在文档中插入以下代码：

<!-- STORY -->

　　这段代码可以控制我们的组件要在文档的哪个部分出现。如果不填写，则默认会先显示文档内容，再显示组件内容。所以我们最好在文档的最前面先添加上述代码，先将我们的组件展示出来，再进行文档编写。

　　这就是笔者目前用过的两个addon了，其他addons读者可以自己尝试，可以让自己的storybook更加个性化，功能更加完善。