快速上手

::: tip 提示

kf-ui 基于 vue3 + ts + Element-plus 再次封装的基础组件

:::

安装

npm install test-kfui -S
&
pnpm add test-kfui -S

使用

前提条件：使用项目必须全局注册 Element-plus组件库

// main.ts
import Kfui from 'test-kfui'
Vue.use(Kfui)

// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions：{
  "types": [
    "test-kfui/components.d.ts",
  ],
}

docs文档结构目录

├─ examples               # VPDemo组件自动解析此文件夹下的所有.vue文件
├─ components             # .md文件
├─ public                 # 静态资源文件
├─ .vitepress
│  ├─ config              # 插件配置
|  │  ├─ global.ts        # 全局变量定义
|  │  └─ plugins.ts       # 自定义.md文件渲染
│  ├─ theme               # 主题配置
│  ├─ utils               # 文档展开隐藏代码高亮
│  ├─ vitepress
|  │  ├─ vp-demo          # VPDemo组件源码
|  │  ├─ style            # VPDemo组件样式
|  │  └─ index.ts         # 暴露VPDemo组件
│  └─ config.ts           # vitepress配置文件
├─ index.md               # 文档home页面
├─ tsconfig.json          # typescript 全局配置
└─ vite.config.ts         # vite 全局配置文件（支持tsx）