Skip to content

lq782655835/vuele

Repository files navigation

vuele

基于ElementUI上的业务组件库.

文档预览:https://lq782655835.github.io/vuele/

Install

vuele业务组件库依赖ElementUI,需要一并安装

# 安装
npm i element-ui vuele -S

Usage(全局)

import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css';
Vue.use(ElementUI)

import vuele from 'vuele';
import 'vuele/dist/vuele.css';
Vue.use(vuele)

Usage(按需引用)

// mixins在页面级使用
import { listMixin as list } from 'vuele';

export default {
    //...
    mixins: [list],
    //...
}

本地开发组件库

本地开发组件库。

npm i
# 本地开发命令
npm run serve
# 在src/components目录下根据组件用途分为基础组件和复杂组件,复杂组件主要供物料使用。开发完成需在对应目录index.ts中注册。
# 在__demo__文件夹可以写预览示例。

git commit msg 规范

$ git commit -m 'feat: add feature'
  • feat: 表示新增了一个功能
  • fix: 表示修复了一个 bug
  • docs: 表示只修改了文档
  • style: 表示修改格式、书写错误、空格等不影响代码逻辑的操作
  • refactor: 表示修改的代码不是新增功能也不是修改 bug,比如代码重构
  • perf: 表示修改了提升性能的代码
  • test: 表示修改了测试代码
  • build: 表示修改了编译配置文件
  • chore: 无 src 或 test 的操作
  • revert: 回滚操作

可使用npm run cm 提交

$ npm run cm

组件库打包及发布

# 发布命令,运行后自动打包
npm publish
npm i
# 本地开发
npm run docs:dev
# 在 docs目录下rds-components中可书写相关文档