Wit-ui

介绍

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

这是我在学习 Vue3 中基于Element-plus 二次封装基础组件文档，希望对你有用。可查看 详细组件案例文档 预览

npm 方式安装使用

npm i @taiping/wit-ui

全局注册使用

前提条件：使用项目必须全局注册 Element-plus组件库

// 在main.js中按下引入
import WitUi from '@taiping/wit-ui'
import '@taiping/wit-ui/lib/index.css'

Vue.use(WitUi)

按需引入

// 在main.js中按下引入
import '@taiping/wit-ui/lib/index.css'
// 单个.vue文件引入
<script setup lang="ts">
  import {WCount, WImportExcel} from "@taiping/wit-ui"
</script>

wit-ui 组件类型提示

需要在使用的项目的tsconfig.json文件中添加以下

compilerOptions: {
"types": ["@taiping/wit-ui/global"],
}

安装依赖

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

npm install -g pnpm

pnpm install

本地运行 vuepress 中组件文档

// docs项目(文档demo示例)基于vue3+vite项目
npm run docs:dev

Git 提交规范

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