Appearance
快速开始
环境要求
- Node.js
>= 18 - Vue
^3.4 - Element Plus
^2.7
安装
bash
npm install vue3-ep-biz-lib element-plus全局注册
ts
// main.ts
import { createApp } from 'vue'
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
import Vue3EpBizLib from 'vue3-ep-biz-lib'
import 'vue3-ep-biz-lib/dist/style.css' // 组件样式(npm 安装时必引)
import App from './App.vue'
const app = createApp(App)
app.use(ElementPlus)
app.use(Vue3EpBizLib) // 注册全部业务组件
app.mount('#app')按需导入
vue
<script setup lang="ts">
// 以 biz-button 为例(组件开发完成后可用)
import { BizButton } from 'vue3-ep-biz-lib'
</script>
<template>
<BizButton type="primary">按需导入按钮</BizButton>
</template>提示:组件库将
vue、element-plus声明为 peerDependencies,请确保业务工程内已安装。
第三方依赖(按需安装)
组件库本体仅新增 qrcode 一个直接依赖(BizCode 使用,随组件库自动安装)。以下组件的功能依赖不会自动安装,使用前请在业务工程内自行准备,详见组件总览 · 第三方依赖说明:
| 组件 | 需准备 | 安装 / 获取 |
|---|---|---|
| BizChart 图表容器 | echarts(可选 peer,懒加载) | npm i echarts |
| BizRichEditor 富文本编辑器 | quill(可选 peer,懒加载) | npm i quill 并 import 'quill/dist/quill.snow.css' |
| BizFileViewer 文件预览 | pdfjs-dist(可选 peer,仅 pdfjs 引擎需要) | npm i pdfjs-dist,配置 worker 后经 pdfjsLib 传入 |
| BizMapPicker 地图选点 | 高德开放平台 Key | 申请 Web端(JS API) Key 并传入 app-key |
未安装对应依赖时,组件会渲染安装指引而不是报错白屏;不使用这些组件的项目安装体积不受影响。
下一步
前往 组件总览 查看全部组件。