# k-view-vue

A Vue.js 3 UI library

[![commitizen](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli)
[![Wei Design](https://img.shields.io/npm/v/k-view-vue.svg?style=flat-square)](https://www.npmjs.org/package/k-view-vue)

---

-   🔭 [Vite](https://vitejs.dev)
-   💪 [Vue3](https://vuejs.org)
-   🔥 TypeScript

[快速开始](https://wei-design.github.io/k-view-vue/)

## 安装

node：>=16.0.0

### npm

这里推荐`pnpm`进行安装

```sh
pnpm install k-view-vue --save
```

### cdn

#### unpkg

[资源浏览](https://unpkg.com/k-view-vue/)

```html
<link rel="stylesheet" href="//unpkg.com/k-view-vue/lib/style.css" />
<script src="//unpkg.com/k-view-vue"></script>
```

#### jsdelivr

[资源浏览](https://cdn.jsdelivr.net/npm/k-view-vue/)

```html
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/k-view-vue/lib/style.css" />
<script src="//cdn.jsdelivr.net/npm/k-view-vue"></script>
```

## 使用

### 全局引入

在`main.js`中

```js
import { createApp } from 'vue'
import App from './App.vue'
// 完整引入组件库
import WeDesign from 'k-view-vue'

const app = createApp(App)
// 全局安装
app.use(WeDesign).mount('#app')
```

组件当中

```vue
<WeButton :loading="true">按钮组件</WeButton>
```

### 按需引入

`main.js`中

```js
import { createApp } from 'vue'
import App from './App.vue'
// 按需引入
import { Button } from 'k-view-vue'

const app = createApp(App)

app.use(Button).mount('#app')
```

组件当中

```vue
<WeButton :loading="true">按钮组件</WeButton>
```

---

## 版本记录

[版本记录](CHANGELOG.md)

有问题欢迎 issue...