custom-dashboard-vue
v0.1.7
Published
✅ 已完成工作
Readme
✅ 已完成工作
库构建配置 (Library Mode)
- 修改
vite.config.ts,配置了build.lib选项,指定src/index.ts为入口。 - 配置了
rollupOptions将vue,pinia,element-plus等作为外部依赖(External),避免打包进库文件中,减小体积。 - 集成了
vite-plugin-dts,自动生成 TypeScript 类型声明文件 (.d.ts)。
- 修改
入口文件封装
- 创建
src/index.ts,统一导出了核心组件 (DashboardContainer)、状态管理 (useDashboardStore)、类型定义及 i18n 实例。 - 提供了默认的 Vue 插件安装方法 (
install),支持通过app.use(CustomDashboard)快速注册。
- 创建
NPM 发布配置
- 更新
package.json:- 设置
main(UMD),module(ESM),types(DTS) 字段。 - 将核心依赖移动至
peerDependencies,确保宿主环境版本一致性。 - 配置
files字段,仅发布dist目录。
- 设置
- 更新
环境验证
- 构建验证:
npm run build成功生成dist/目录,包含 ES Module 和 UMD 格式产物及类型文件。 - 开发验证:
npm run dev运行正常(端口 5174),本地演示环境可正常加载仪表盘组件。
- 构建验证:
🚀 如何使用
1. 本地开发与调试
npm run dev启动本地服务器,通过 src/main.ts 入口调试组件功能。
2. 构建发布
npm run build
npm publish构建产物将输出到 dist/ 目录,随后即可发布到 NPM 仓库。
3. 在其他项目中使用 安装包后:
import { createApp } from 'vue';
import CustomDashboard from 'custom-dashboard-vue';
import 'custom-dashboard-vue/dist/custom-dashboard-vue.css'; // 引入样式
const app = createApp(App);
app.use(CustomDashboard); // 全局注册组件现在项目已准备就绪,您可以随时进行发布或继续添加更多部件。
🔄 变更详情
更新入口文件 (
src/index.ts)- 新增导出了
DashboardEditor组件。 - 在默认插件安装 (
install) 方法中注册了全局组件<DashboardEditor>。
- 新增导出了
调整构建配置 (
vite.config.ts)- 修改了
vite-plugin-dts的配置,从排除列表 (exclude) 中移除了src/views/DashboardEditor.vue,确保为其生成 TypeScript 类型声明文件。
- 修改了
📦 验证结果
执行 npm run build 构建成功,无错误。
现在,使用该库的项目可以通过以下方式引入编辑器组件:
import { DashboardEditor } from 'custom-dashboard-vue';
// 或者在模板中直接使用(如果使用了 app.use 安装插件)
// <DashboardEditor />请注意,DashboardEditor 组件依赖于 dashboardStore 中的状态,使用前请确保 Pinia Store 已正确初始化。
常见问题
element-plus部分组件需要手动引入,否则会报错

