# wit-ui

**Repository Path**: taiping520/wit-ui

## Basic Information

- **Project Name**: wit-ui
- **Description**: Vue3 基于Element-Plus二次封装组件
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-13
- **Last Updated**: 2023-11-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Wit-ui

## 介绍

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

这是我在学习 Vue3 中基于[Element-plus](https://element-plus.org/zh-CN/)
二次封装基础组件文档，希望对你有用。可查看 [详细组件案例文档](https://gitee.com/taiping520/wit-ui) 预览

<p style="display: flex;
    justify-content: center;
    align-items: center;
    margin-top: 10px;">
  <a href="https://gitee.com/taiping520/wit-ui" target="_blank">
    <img src="https://img.shields.io/badge/vue-3.3.8-brightgreen.svg" alt="vue3">
  </a>
  <a href="https://gitee.com/taiping520/wit-ui" target="_blank">
    <img src="https://gitee.com/taiping520/wit-ui/badge/star.svg?theme=dark" alt="t-ui-plus">
  </a>
   <a href="https://www.npmjs.com/package/@taiping/wit-ui" target="_blank">
      <img alt="npm" src="https://img.shields.io/npm/v/@taiping/wit-ui.svg" />
    </a>
</p>

## npm 方式安装使用

```shell
npm i @taiping/wit-ui
```

## 全局注册使用

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

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

Vue.use(WitUi)
```

## 按需引入

```vue
// 在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文件中添加以下

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

```

## 安装依赖

> ### 注意: 本地环境版本最好安装 [Node.js 18.x+](https://nodejs.org/en)、[pnpm 7.x+](https://github.com/pnpm/pnpm/)

```shell
npm install -g pnpm

pnpm install

```

## 本地运行 vuepress 中组件文档

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

```

## Git 提交规范

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