my-test-vue-ui
v1.0.0
Published
A Component Library for Vue.js.
Downloads
2
Readme
gwi-ui-qy
安装
npm i gwi-qy-ui
引用
全局引用
import GwiUi from 'gwi-qy-ui'
import 'gwi-ui-qy/lib/theme/index.css'
Vue.use(GwiUi)
开发指南
框架介绍
build, config --- 打包的一些配置 docs --- 组件开发文档 examples --- 开发调试 packages --- 组件目录 public --- 入口html文件 src --- 组件引入配置 utils --- 工具类 vue.config.js --- webpack 配置
开始开发
首先在packages 文件夹新建一个组件文件夹。以按钮组件为例 1.新建 Button文件夹 (命名最好跟组件相关) 2.在Button文件夹新建一个index.js文件和一个src文件夹。index.js的作用是导出组件,以便页面引入。(具体导出参考代码) 3.在src文件夹新建一个index.vue文件。index.vue 主要实现组件功能。 4.组件开发完之后,在根目录下的src文件夹里的index.js里导入该组件。具体参考src/index.js 5.在根目录下的src文件夹里的lib-list.js,添加组件名以及路径。 具体参考src/lib-list.js. 执行打包指令会从里面写好的路径去打包组件。 6.执行 npm run lib:pub 执行打包指令。打包完后的代码在lib文件夹下。
指令
打包指令
npm run lib:pub
本地启动示例
npm run serve
组件使用文档
npm run docs:dev
每开发完一个组件,书写该组件对应的使用文档。在根目录下的docs文件夹下。 组件文件使用vuepress开发。具体请参考官方文档: https://www.vuepress.cn/guide/