# neatui-vue

**Repository Path**: towardly/neatui-vue

## Basic Information

- **Project Name**: neatui-vue
- **Description**: 基于vue3的一些简单的基础的ui框架
- **Primary Language**: TypeScript
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: https://dvshu.github.io/neatui-vue/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-13
- **Last Updated**: 2024-08-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Vue3-ui

## README

# neatui-vue

`Neat UI` 是一个基于 `Vue3` 的轻量级的 `UI` 组件库，提供基础的 `UI` 组件，方便开发。

## 使用

### 安装依赖

1. 安装 UI 库

```shell
npm install @asteres/neatui-vue
```

2. 安装自动导入插件

```shell
npm install -D unplugin-vue-components unplugin-auto-import neatui-vue-resolver
```

3. 修改 Vite 配置

```js
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import AutoImport from 'unplugin-auto-import/vite';
import Components from 'unplugin-vue-components/vite';
import NeatuiResolver from 'neatui-vue-resolver';

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue(),
    AutoImport({
      resolvers: [NeatuiResolver()],
      dts: 'src/auto-imports.d.ts',
    }),
    Components({
      resolvers: [NeatuiResolver()],
      dts: 'src/components.d.ts',
    }),
  ],
});
```

4. 引入全局 CSS 变量文件

在 `main.ts` 中引入全局 CSS 变量文件

```js
import '@asteres/neatui-vue/style/vars.css';
```

## 文档

[中文 文档](https://dvshu.github.io/neatui-vue/)

## [更新记录](https://github.com/DvShu/neatui-vue/blob/main/CHANGELOG.md)

## LICENSE

neatui-vue is open source software licensed as [MulanPSL-2.0](https://github.com/DvShu/neatui-vue/blob/main/LICENSE).