Vue 集成 storybook的方法

 更新时间:2021年01月14日 09:52:02   作者:PKS生态服务平台  
这篇文章主要介绍了Vue 集成 storybook的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

一、storybook 介绍

storybook是一个开源的组件管理、文档UI展示工具,用来在大型的项目中,让团队成员一个可以知道到团队已开发的组件,避免编写重复的组件,减少团队沟通时间和开发成本

二、storybook 环境搭建

1. 依赖安装

npm install @storybook/vue --save-dev
npm install vue-loader vue-template-compiler @babel/core babel-loader babel-preset-vue --save-de

2.入口配置

在项目根目录新建 .storybook/config.js 文件##.storybook/config.js#

import { configure } from '@storybook/vue'
// 加载所有的组件故事
configure(require.context('./stories', true, /\.js$/), module)

3.自定义wepback配置

在项目根目录新建 .storybook/webpack.config.js 文件

// 在这里你可以重写storybook 默认的webpack配置
module.exports = async ({ config, mode }) => {
 // `mode` has a value of 'DEVELOPMENT' or 'PRODUCTION'
 
// 新加less语法加载器
 config.module.rules.push({
  test: /\.less$/,
  use: ["style-loader", "css-loader", "less-loader", {
   loader: 'style-resources-loader',
   options: {
    patterns: [
     path.resolve(__dirname, '../src/assets/style/common/mixins.less')
    ]
   }
  }]
 })
 
 // 新增@别名
 config.resolve.alias = Object.assign(config.resolve.alias, {
  '@': path.resolve(__dirname, '../src')
 })
 
 // Return the altered config
 return config
}

4.ajax跨域代理

在项目根目录新建 .storybook/middleware.js 文件

const proxy = require('http-proxy-middleware')
module.exports = function expressMiddleware(router) {
 router.use(
  '/api',
  proxy({
   target: `http://locahost:5000`, // 服务器 api地址
   changeOrigin: true
  })
 )

5.相关插件介绍和使用 (1)knobs

knobs插件提供一个表单控制台,用户可以通过表单控制台来改变组件相关属性,展示不同属性下的组件

(2)actions

actions插件让用户在对组件的操作,可以反应在底部的日志里面

(3)storysource

addon插件可以让你直接在界面上看到当前sotry的源码

(4)docs

addon-docs插件让你可以为你的组件编写文档

(5)插件引入

安装相关依赖

npm install @storybook/addon-knobs @storybook/addon-actions @storybook/addon-storysource @storybook/addon-docs --dev

在项目根目录新建 .storybook/addons.js 文件

import '@storybook/addon-knobs/register';
import '@storybook/addon-actions/register';
import '@storybook/addon-storysource/register';
import '@storybook/addon-docs/register';

6.展示自己的组件

在项目根目录下的stories文件夹中,新建一个任意名称的js文件

import Vue from 'vue';
// 这里导入你自己的组件,
import MyButton from '@/components/Button.vue';
 
export default { title: 'Button' };
 
export const withText = () => '<my-button>with text</my-button>';
 
export const withEmoji = () => '<my-button>😀 😎 👍 💯</my-button>';
 
export const asAComponent = () => ({
 components: { MyButton },
 template: '<my-button :rounded="true">rounded</my-button>'
});

最后在根目录命令行启动storybook就搞定了

npm run storybook

到此这篇关于C#实现窗体与子线程的交互的方法的文章就介绍到这了,更多相关C#实现窗体与子线程的交互内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • vue3 ts组合式API异常onMounted is called when there is no active component解决

    vue3 ts组合式API异常onMounted is called when&

    这篇文章主要为大家介绍了vue3 ts组合式API异常onMounted is called when there is no active component问题解决,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-05-05
  • vue-devtools的安装与使用教程

    vue-devtools的安装与使用教程

    vue-devtools是一款基于chrome游览器的插件,用于调试vue应用,这可以极大地提高我们的调试效率,这篇文章主要介绍了vue-devtools的安装与使用教程,需要的朋友可以参考下
    2023-03-03
  • 详解vue-socket.io使用教程与踩坑记录

    详解vue-socket.io使用教程与踩坑记录

    本文主要介绍了vue-socket.io使用教程与踩坑记录,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-04-04
  • Vue 组件参数校验与非props特性的方法

    Vue 组件参数校验与非props特性的方法

    这篇文章主要介绍了Vue 组件参数校验与非props特性的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-02-02
  • 通过vue刷新左侧菜单栏操作

    通过vue刷新左侧菜单栏操作

    这篇文章主要介绍了通过vue刷新左侧菜单栏操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • Vue 组件上的v-model双向绑定原理解析

    Vue 组件上的v-model双向绑定原理解析

    这篇文章主要介绍了Vue 组件上的v-model双向绑定原理,从本文的学习可以知道组件上v-model指令的本质也是生成了value属性和input事件,具体实例代码跟随小编一起看看吧
    2022-05-05
  • Vue中使一个div铺满全屏的实现

    Vue中使一个div铺满全屏的实现

    最近在项目开发中,就遇到了这个问题,Vue中如何使一个div铺满全屏,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-07-07
  • Vue3.4中v-model双向数据绑定新玩法详解

    Vue3.4中v-model双向数据绑定新玩法详解

    defineModel 是一个新的 <script setup> 宏,旨在简化支持 v-model 的组件的实现, 这个宏用来声明一个双向绑定 prop,下面我们就来看看他的具体使用吧
    2024-03-03
  • Vue 构造选项 - 进阶使用说明

    Vue 构造选项 - 进阶使用说明

    这篇文章主要介绍了Vue 构造选项 - 进阶使用说明,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • vue 组件prop验证作用示例解析

    vue 组件prop验证作用示例解析

    这篇文章主要为大家介绍了vue组件prop验证作用示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08

最新评论