Skip to content

包使用概览 ​

Lumal 按职责拆包。应用只消费 公开 exports 入口 与样式路径,不要依赖 packages/*/src 或测试内部文件。

本组文档对应已发布版本 0.0.4-beta;安装时显式指定版本并保持所有 Lumal 包同版。版本变更与发布方式见 更新日志。

选型建议 ​

场景推荐包
后台壳、布局、权限、表单表格@lumal/core + icons 系列
后台图表工作流@lumal/charts
大屏边框 / 装饰 / 飞线等@lumal/datav
可编排驾驶舱布局与 Designer@lumal/cockpit(+ 可选 datav)
Vite 自动导入 / monorepo alias@lumal/vite
从 Vben 迁移@lumal/vben-compat
快速起项目create-lumal-admin

包卡片 ​

包说明文档本地路径
@lumal/core安装器、布局、路由权限、请求、主题、Schema 组件在线文档packages/core
@lumal/icons框架无关图标内核在线文档packages/icons
@lumal/icons-vueVue 图标组件在线文档packages/icons-vue
@lumal/chartsECharts 图表与面板在线文档packages/charts
@lumal/datavDataV 风格可视化组件在线文档packages/datav
@lumal/cockpit驾驶舱编排框架在线文档packages/cockpit
@lumal/viteResolver 与 workspace alias在线文档packages/vite
@lumal/vben-compatVben 常用 API 兼容在线文档packages/vben-compat
create-lumal-admin脚手架 CLI在线文档packages/create-lumal-admin

npm 包地址与安装方式见 安装与版本。

安装顺序(典型 Admin) ​

bash
pnpm add vue@^3.5 vue-router@^4.5 element-plus@^2.11 @iconify/vue@^5
pnpm add @lumal/core@0.0.4-beta @lumal/icons@0.0.4-beta @lumal/icons-vue@0.0.4-beta
# 按需
pnpm add @lumal/charts@0.0.4-beta echarts@^6 vue-echarts@^8
pnpm add -D @lumal/vite@0.0.4-beta

Pinia 按应用需要安装。纯服务接入优先使用 @lumal/core/minimal / request,无需 Element Plus;UI 入口需安装对应 peer 与样式。

开发工作区内的新功能时使用 workspace:* 或 file:,不要把未发布 API 当作 npm 同版能力,见 安装与版本。

基于 MIT 许可发布 · Vue 3 · TypeScript · Vite · Element Plus