open-index/open-npm huggingface dataset:
npm package: @jrj-front-end/jrj-ui
Description: Vue3 中基于Element-plus二次封装基础组件文档
Author: jrj-front-end
Latest version: 0.0.4-beta.7

# Jrj-UI

## 介绍

> 基于 vue3+ ts+ Element-plus 二次封装组件

基于 vue3+ ts+ Element-plus 二次封装组件，同时存放了业务开发中一些常用的组件。

## 动态效果图

<img src="./README_GIF/JrjUI__demo.gif">

## npm 方式安装使用

```shell
npm i @jrj-front-end/jrj-ui
```

## 全局注册使用

> ### 前提条件：使用项目必须全局注册 Element-plus 组件库

```js
// 在main.js中按下引入
import JrjUI from '@jrj-front-end/jrj-ui'
import '@jrj-front-end/jrj-ui/lib/style.css'
Vue.use(JrjUI)
```

## 按需引入

```js
// 在main.js中按下引入
import '@jrj-front-end/jrj-ui/lib/style.css'
// 单个.vue文件引入
;<script setup lang="ts">
  import {JButton, JDiv} from "@jrj-front-end/jrj-ui"
</script>
```

## Jrj-UI Volar 组件类型提示

```js
// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions：{
  "types": [
      "@jrj-front-end/jrj-ui/components.d.ts",
    ],
}

```

## Vue3 + Vite 项目中安装引入报如下错误的解决方法

> #### 把项目的 vite 版本升级到 4+

<img src="./README_GIF/error.png">

## 安装依赖

> ### 注意: 本地环境版本最好安装 [Node.js 16.x+](https://nodejs.org/en)、[yarn 1.15.x+](https://www.npmjs.com/package/yarn?activeTab=versions)

## 本地运行 vuepress 中组件文档

```shell
// docs项目(文档demo示例)基于vue3+vite项目
npm run docs:dev

```


## Git 提交规范

- `ci`: ci 配置文件和脚本的变动;
- `chore`: 构建系统或辅助工具的变动;
- `fix`: 代码 BUG 修复;
- `feat`: 新功能;
- `perf`: 性能优化和提升;
- `refactor`: 仅仅是代码变动，既不是修复 BUG 也不是引入新功能;
- `style`: 代码格式调整，可能是空格、分号、缩进等等;
- `docs`: 文档变动;
- `test`: 补充缺失的测试用例或者修正现有的测试用例;
- `revert`: 回滚操作;