https://github.com/lq782655835/vuele
基于ElementUI上的业务组件库
https://github.com/lq782655835/vuele
component-library componets element-ui
Last synced: 10 months ago
JSON representation
基于ElementUI上的业务组件库
- Host: GitHub
- URL: https://github.com/lq782655835/vuele
- Owner: lq782655835
- Created: 2020-04-16T06:31:02.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-21T01:50:12.000Z (about 6 years ago)
- Last Synced: 2025-08-09T18:49:57.619Z (11 months ago)
- Topics: component-library, componets, element-ui
- Language: JavaScript
- Homepage: https://lq782655835.github.io/vuele/
- Size: 2.26 MB
- Stars: 11
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## vuele
基于ElementUI上的业务组件库.
文档预览：https://lq782655835.github.io/vuele/
### Install
vuele业务组件库依赖ElementUI，需要一并安装
``` bash
# 安装
npm i element-ui vuele -S
```
### Usage(全局)
``` javascript
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(按需引用)
``` javascript
// mixins在页面级使用
import { listMixin as list } from 'vuele';
export default {
//...
mixins: [list],
//...
}
```
### 本地开发组件库
本地开发组件库。
``` bash
npm i
# 本地开发命令
npm run serve
# 在src/components目录下根据组件用途分为基础组件和复杂组件，复杂组件主要供物料使用。开发完成需在对应目录index.ts中注册。
# 在__demo__文件夹可以写预览示例。
```
### git commit msg 规范
``` bash
$ git commit -m 'feat: add feature'
```
- feat: 表示新增了一个功能
- fix: 表示修复了一个 bug
- docs: 表示只修改了文档
- style: 表示修改格式、书写错误、空格等不影响代码逻辑的操作
- refactor: 表示修改的代码不是新增功能也不是修改 bug，比如代码重构
- perf: 表示修改了提升性能的代码
- test: 表示修改了测试代码
- build: 表示修改了编译配置文件
- chore: 无 src 或 test 的操作
- revert: 回滚操作
### 可使用npm run cm 提交
``` bash
$ npm run cm
```
### 组件库打包及发布
``` bash
# 发布命令，运行后自动打包
npm publish
```
``` bash
npm i
# 本地开发
npm run docs:dev
# 在 docs目录下rds-components中可书写相关文档
```