Skip to content

MvM-OLO/vmf-kit

Repository files navigation

图片名称

vmf-kit VUE3 多功能前端整合包

一个 实用(开发中)的前端库。

📦 安装

npm install vmf-kit
# 或者
pnpm add vmf-kit
# 或者
yarn add vmf-kit

🔨 模块说明

模块 描述 路径
Constants 常量 vmf-kit/constants
Plugins 二次封装的第三方插件 vmf-kit/plugins
Components 通用组件 vmf-kit/components
Utils 工具函数 vmf-kit/utils
Hooks Vue Hooks vmf-kit/hooks

📝 使用示例

// 方式一:从主包导入
import { Constants, Utils } from "vmf-kit";
const { PCA_CODE } = Constants;
const { merge, cn } = Utils;

// 方式二:从子包导入(推荐,tree-shaking 更友好)
import { PCA_CODE } from "vmf-kit/constants";
import { merge, cn } from "vmf-kit/utils";

📚 详细说明

🔍 Constants 常量

  • PCA_CODE: 行政区域编码配置,适用于级联选择

🔌 Plugins 插件

  • Gantt 甘特图
    • 支持导出 PDF
    • 支持导出图片
    • 支持依赖线
    • 更多功能开发中...
  • ECharts
    • 二次封装的图表组件
    • 提供常用配置项

🎨 Components 组件

  • FilePreview 文件预览 - 通用文件预览组件,纯前端实现,支持:

    • 图片预览(缩放/旋转/拖拽)
    • PDF 预览(多页渲染)
    • Word (.docx) 预览
    • Excel (.xlsx/.xls/.csv) 预览(多 Sheet 切换)
    • PPT (.pptx) 预览
    • 文本文件预览
    • 代码文件语法高亮(支持 20+ 语言)
  • RichTextEditor 富文本编辑器 - 基于 Tiptap 2.x 的富文本编辑器,支持:

    • 全功能工具栏(文字格式、标题、列表、表格、代码块、图片、链接等)
    • 工具栏可配置,按需显示/隐藏工具项
    • SVG 图标,所有平台渲染一致
    • 文件选择弹窗上传图片(支持截图粘贴、拖拽上传)
    • 内联弹出框插入链接
    • 配套 RichTextViewer 只读渲染组件
  • 更多组件开发中...

🛠 Utils 工具函数

  • Core
    • window: 窗口相关工具函数
    • merge: 深度合并对象
    • dom: DOM 操作工具
    • diff: 对象差异比较
    • cn: 类名合并工具
  • Helpers
    • findMenuByPath: 根据路径查找菜单
  • Color
    • generator: 颜色生成器

🎣 Hooks

  • onMountedOrActivated: 在组件挂载或激活时执行
  • 更多 hooks 开发中...

🔧 类型支持

本库使用 TypeScript 编写,提供完整的类型定义文件,支持代码提示。

文档地址

文档地址

👥 作者

tory-fu


🚧 开发中,欢迎提供建议和反馈

About

a mutifunctional vue3 lib

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors