# veno-ui

**Repository Path**: qq15725/veno-ui

## Basic Information

- **Project Name**: veno-ui
- **Description**: 一个 Vue 3 UI 组件库。Vuetify 3 变种。使用 TypeScript 。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://venoui.fdota.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-07
- **Last Updated**: 2022-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Vue, UI, TypeScript, Library, components

## README

<h1 align="center">Veno UI</h1>

<p align="center">
  <a href="https://github.com/qq15725/veno-ui/blob/master/LICENSE" class="mr-3">
    <img src="https://img.shields.io/npm/l/veno-ui.svg" alt="License">
  </a>
  <a href="https://www.npmjs.com/package/veno-ui">
    <img src="https://img.shields.io/npm/v/veno-ui.svg" alt="Version">
  </a>
</p>

<p align="center">Veno UI - 一个 Vue 3 UI 组件库</p>

## 文档

- [www.venojs.com](https://www.venojs.com) 
- [国内文档镜像](https://venoui.fdota.com)

## 特性

### 自定义主题

组件默认属性值，风格色皆可调。

### 无障碍设计

所有组件遵循 [WAI-ARIA](https://www.w3.org/TR/wai-aria-practices) 。

### 使用 TypeScript

所有组件 TypeScript 编写，类型安全。

## 安装

使用 npm

```sh
npm i veno-ui
```

使用 yarn

```sh
yarn add veno-ui
```

使用 pnpm

```sh
pnpm add veno-ui
```

## 例子

导入全部组件的例子，按需导入请查看文档了解更多。

```typescript
import { createApp } from 'vue'
import App from './App.vue'

import 'veno-ui/styles'
import { createVeno } from 'veno-ui'
import * as components from 'veno-ui/components'
import * as directives from 'veno-ui/directives'
import * as providers from 'veno-ui/providers'
const veno = createVeno({
  components,
  directives,
  providers,
})

createApp(App).use(veno).mount('#app')
```

## 相关的库

| 项目               | 介绍                                       |
| --------------------- |------------------------------------------|
| [veno-admin] | Veno UI 的后台管理项目模板。                       |
| [@veno-ui/markdown] | Veno UI 的 Markdown 渲染器                   |
| [@veno-ui/vite-plugin-markdown] | Veno UI 在 Vite 下的 Markdown 文件解析          |

[veno-admin]: https://github.com/qq15725/veno-admin
[@veno-ui/markdown]: https://github.com/qq15725/veno-ui/blob/master/packages/markdown
[@veno-ui/vite-plugin-markdown]: https://github.com/qq15725/veno-ui/blob/master/packages/vite-plugin-markdown

## 参与开发

安装依赖

```sh
pnpm i
```

编译所有插件和库

```sh
pnpm run build
```

运行开发环境（文档工程）

```sh
pnpm run dev
```

## 许可

Veno UI 使用 [MIT](https://github.com/qq15725/veno-ui/blob/master/LICENSE) 许可，大量代码基于 [Vuetify 3](https://github.com/vuetifyjs/vuetify/tree/next) ，遵循 [MIT](https://github.com/vuetifyjs/vuetify/blob/next/LICENSE.md) 许可。