@ykz/ykz-ui v1.0.7

ykz-ui

云客赞页面统一UI组件库

使用

配置npm源

项目根目录下新建.npmrc文件，写入内容：

registry=http://npm.yunkezan.com

npm下载

# using npm
npm install @ykz/ykz-ui -S

# using yarn
yarn add @ykz/ykz-ui

项目中引入

import YKZUI from '@ykz/ykz-ui'
// 注意需要单独引入样式文件
import '@ykz/ykz-ui/lib/style.css'

Vue.use(YKZUI)

开发

分支名规范

开发分支：组件名_开发者姓名

尺寸单位

本组件库使用的rem基值为75，组件调用时传入的尺寸以750设计稿为准；在开发组件时，若有内联样式（即在DOM上用style设置的样式），则需要通过src/utils/pxToRem提供的方法将单位转成rem

单元测试

建议使用单元测试，在test/unit/specs目录下自建测试脚本，根目录下执行npm test运行单元测试。（由于单元测试脚本编写比较花时间，所以视情况决定是否进行单元测试）

demo自测调试

请在/examples/pages目录下自建demo页面，执行npm start开启本地调试

打包

若有新增组件，需要首先执行npm run build:entry，会自动更新build/components.json和src/index.js，然后提交开发分支，由刘康合并到master分支，在master分支上执行npm run build:lib命令打包组件库，生成的lib目录为引用方真实调用的地方。

发布组件

发布组件之前需要先更改package.json文件中的version，在原先版本基础上+1

目录结构

├── build                           构建脚本目录
│   ├── webpack.base.conf.js            webpack基础配置,开发环境,生产环境都依赖   
│   ├── webpack.dev.conf.js             webpack开发环境配置
│   ├── webpack.prod.conf.js            webpack生产环境配置
│   ├── lib.conf.js                     打包生成lib目录的webpack配置文件            
│   ├── build.js                        组件打包执行脚本
|   |—— build-entry.js                  生成build/components.json和src/index.js的方法
|   |—— components.json                 组件列表json
│   ├── utils.js                        构建相关工具方法
├── config                          项目配置
│   ├── dev.env.js                      开发环境变量
│   ├── index.js                        项目配置文件
│   ├── prod.env.js                     生产环境变量
├── exmaples                        组件开发的本地调试demo目录
├── packages                        组件源码目录
├── test                            测试目录
│   ├── unit                            单元测试脚本
├── lib                             组件打包输出目录
│   ├── index.js                        业务工程引用的实际入口文件
├── src                             源码目录    
│   ├── index.js                        组件入口文件
│   ├── assets                          图片、字体等资源目录
│   ├── utils                           组件使用到的一些工具方法
│   ├── styles                          样式资源
│   │   └── var.less                      变量
├── .eslintrc.js                    eslint规则配置
├── .postcssrc.js                   postcss配置
├── .npmignore                      npm上传忽略文件
├── .npmrc                          npm源配置
├── .gitignore                      git上传忽略文件
├── README.md                       项目介绍
├── index.html                      example页面入口模板html
├── package.json