前端文档

Appearance

On this page

快速上手 ​

提示

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

安装 ​

bash
npm install lighting-pro -S
&
pnpm install lighting-pro -S
npm install lighting-pro -S
&
pnpm install lighting-pro -S

全局引入 ​

js
// main.ts 
import LightingUiPro from 'lighting-pro'
import 'lighting-pro/lib/style.css'
const app = createApp(App)
app.use(LightingUiPro)
app.mount('#app')
// main.ts 
import LightingUiPro from 'lighting-pro'
import 'lighting-pro/lib/style.css'
const app = createApp(App)
app.use(LightingUiPro)
app.mount('#app')

局部引入 ​

js
// main.ts
import 'lighting-pro/lib/style.css'
// index.vue
import { TButton } from 'lighting-pro'
<template>
  <TButton>按钮</TButton>
</template>
// main.ts
import 'lighting-pro/lib/style.css'
// index.vue
import { TButton } from 'lighting-pro'
<template>
  <TButton>按钮</TButton>
</template>

lighting-pro组件库 Volar 类型提示 ​

js
// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions：{
  "types": [
      "lighting-pro/components.d.ts",
    ],
}
// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions：{
  "types": [
      "lighting-pro/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）
├─ 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）