Skip to content

bsprcomp/ep-ui

Repository files navigation

EP-ui

介绍

基于 vue3+ ts+ Element-plus 二次封装组件

npm 方式安装使用

npm i @bscomp/ep-ui

全局注册使用

前提条件:组件库依赖 Element-plus 组件库

// main.js
import { createApp } from "vue"
import App from "./App.vue"
import ElementPlus from "element-plus"
import "element-plus/dist/index.css"
import "element-plus/theme-chalk/dark/css-vars.css"
import locale from "element-plus/es/locale/lang/zh-cn"
// element-plus图标
import * as ElementPlusIconsVue from "@element-plus/icons-vue"

import EP from "@bscomp/ep-ui"
import "@bscomp/ep-ui/lib/style.css"
const app = createApp(App)
// 注册所有图标
for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
  app.component(key, component)
}
//全局注册element
app.use(ElementPlus, {
  locale // 语言设置
})
app.use(EP)
app.mount("#app")

按需引入

// 在main.js中按需引入
import "@bscomp/ep-ui/lib/style.css"
// 单个.vue文件引入
;<script setup lang="ts">
  import {EPTable} from "@bscomp/ep-ui"
</script>

ep-ui Volar 组件类型提示

需要在项目 src 文件下的 env.d.ts 中引入

/// <reference types="@bscomp/ep-ui/lib/components.d.ts" />

安装依赖

注意: 本地环境版本最好安装 Node.js 18.x+

# 安装依赖
npm install
>npm config set registry https://registry.npmmirror.com/ 切换淘宝镜像源
>npm install

Git 提交规范(PR 提交规范)

  • ci: ci 配置文件和脚本的变动;
  • chore: 构建系统或辅助工具的变动;
  • fix: 代码 BUG 修复;
  • feat: 新功能;
  • perf: 性能优化和提升;
  • refactor: 仅仅是代码变动,既不是修复 BUG 也不是引入新功能;
  • style: 代码格式调整,可能是空格、分号、缩进等等;
  • docs: 文档变动;
  • test: 补充缺失的测试用例或者修正现有的测试用例;
  • revert: 回滚操作;