ep-craft
v0.1.11
Published
A Vue 3 component library based on element-plus with ep- prefix
Maintainers
Readme
ep-craft
基于 Vue 3 和 Element Plus 的组件库封装,统一使用 Ep 前缀对外提供组件与服务类 API。
环境要求
- Node.js:建议 18+(Vite 5 需要较新的 Node 版本)
- 包管理器:npm(项目已包含
package-lock.json)
依赖安装
在项目根目录执行:
npm install开发与构建
组件库构建
npm run build构建产物输出到 dist/,包含:
dist/ep-craft.jsdist/index.d.tsdist/index.css
生成代码/文档(可选)
npm run gen
npm run gen:docs本地启动文档站
npm run docs:dev构建与预览文档站
npm run docs:build
npm run docs:preview在业务项目中使用
ep-craft 的对等依赖(peerDependencies)为 vue 与 element-plus,请确保业务项目已安装并满足版本要求。
方式一:全量注册
import { createApp } from 'vue'
import App from './App.vue'
import EpCraft from 'ep-craft'
import 'ep-craft/dist/index.css'
const app = createApp(App)
app.use(EpCraft)
app.mount('#app')方式二:按需导入(配合 unplugin-vue-components)
安装依赖:
npm i -D unplugin-vue-components在 vite.config.ts 中配置解析器:
import Components from 'unplugin-vue-components/vite'
import { EpCraftResolver } from 'ep-craft/resolver'
export default {
plugins: [
Components({
resolvers: [EpCraftResolver()],
}),
],
}Element Plus 服务类 API(Ep 前缀)
库内对 Element Plus 的部分服务类 API 做了前缀导出,便于统一使用:
EpMessageEpMessageBoxEpNotificationEpLoadingEpInfiniteScroll
import { EpMessage } from 'ep-craft'
EpMessage.success('Hello')