# vue-devui

**Repository Path**: zct1989/vue-devui

## Basic Information

- **Project Name**: vue-devui
- **Description**: 一个基于 DevUI Design 设计体系的 Vue3 组件库，使用最新的 Vite + Vue3 + TypeScript + JSX 搭建，包含60多个简洁、易用、灵活的组件。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: dev
- **Homepage**: https://devui.gitee.io
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 480
- **Created**: 2021-12-12
- **Last Updated**: 2021-12-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <a href="https://devui.design/home" target="_blank" rel="noopener noreferrer">
    <img alt="DevUI Logo" src="https://gitee.com/devui/vue-devui/raw/dev/packages/devui-vue/public/logo.svg?sanitize=true" width="180" style="max-width:100%;">
  </a>
</p>

Vue DevUI 是 Vue3 版本的 DevUI 组件库，基于 [https://github.com/devcloudfe/ng-devui](https://github.com/devcloudfe/ng-devui)，倡导`沉浸`、`灵活`、`至简`的设计价值观。

DevUI 官方网站：[https://devui.design](https://devui.design)

DevUI开源项目正在参加[2021年度OSC中国开源项目评选](https://www.oschina.net/project/top_cn_2021/?id=205&ticket=4b10864b99e57311d9897964acfc0c9c)，欢迎大家给我们`DevUI Design`投上宝贵的一票：

[DevUI开源项目-2021年度OSC中国开源项目评选投票](https://www.oschina.net/project/top_cn_2021/?id=205&ticket=4b10864b99e57311d9897964acfc0c9c)

想了解[DevUI](https://devui.design)开源的故事，可以阅读以下文章：

[DevUI开源的故事](https://juejin.cn/post/7029092585452863525/)

# 当前状态: Beta

该项目还处于孵化和演进阶段，欢迎大家参与到 Vue DevUI 项目的建设中来！🎉🎉

通过参与 Vue DevUI 项目，你可以：
- 🔥 学习最新的 `Vite`+`Vue3`+`TypeScript`+`JSX` 技术
- 🎁 学习如何设计和开发组件
- ⭐ 参与到开源社区中来
- 🎊 结识一群热爱学习、热爱开源的朋友

[贡献指南](https://gitee.com/devui/vue-devui/wikis/【必看】快速开始)

# 快速开始

## 1 安装依赖

```
yarn(推荐)

or

npm i
```

## 2 启动

```
yarn dev(推荐)

or

npm run dev
```

## 3 访问

[http://localhost:3000/](http://localhost:3000/)

## 4 生产打包

```
yarn build(推荐)

or

npm run build
```

# 使用 Vue DevUI

## 1. 安装

```
yarn add vue-devui
```

## 2. 全量引入

在`main.ts`文件中编写以下代码：
```
import { createApp } from 'vue'
import App from './App.vue'

// Step 1: 引入 Vue DevUI 组件库
import DevUI from 'vue-devui'
// Step 2: 引入组件库样式
import 'vue-devui/style.css'

createApp(App)
.use(DevUI) // Step 3: 使用 Vue DevUI
.mount('#app')
```

## 3. 按需引入

除了全量引入，我们也支持单个组件按需引入。

在`main.ts`文件中编写以下代码：
```
import { createApp } from 'vue'
import App from './App.vue'

// Step 1: 引入单个组件
import { Button } from 'vue-devui'
// or import Button from 'vue-devui/button'
// Step 2: 引入组件样式
import 'vue-devui/button/style.css'

createApp(App)
.use(Button) // Step 3: 使用组件
.mount('#app')
```

## 4. 配置自动按需引入`unplugin-vue-components`（推荐）

配置`unplugin-vue-components`插件可以无需引入Vue DevUI就可以直接按需使用其中的组件，具体使用方式如下：

在`vite.config.ts`文件中添加以下代码：
```
import Components from 'unplugin-vue-components/vite'
import { DevUiResolver } from 'unplugin-vue-components/resolvers'

export default defineConfig({
  plugins: [
    vue(),

    // 新增
    Components({
      resolvers: [
        DevUiResolver()
      ]
    })
  ]
})
```

配置了以上插件，就可以直接在代码中使用`Vue DevUI`的组件，而无需在`main.ts`文件中引入`Vue DevUI`。

## 5. 使用

```
<template>
  <d-button>确定</d-button>
</template>
```

# 图标库

图标库推荐使用[DevUI图标库](https://devui.design/icon/ruleResource)，也可以使用第三方图标库，比如：iconfont。

## 使用DevUI图标库

### 安装

```
yarn add @devui-design/icons(推荐)

or

npm i @devui-design/icons
```

### 引入

在`main.ts`文件中，编写以下代码：

```
import '@devui-design/icons/icomoon/devui-icon.css'
```

### 使用

```
<d-icon name="love" color="red"></d-icon>
```

# License

[MIT](https://gitee.com/devui/vue-devui/blob/dev/LICENSE)