系统组件
TODO 注意,如果 todo 被修复,不要删除,标记(这条可以忽略)
# 1. 常用组件
【done】TODO @AI:vben 官方的组件,优先使用它官方文档里的;
【done】TODO 案例的超链接,都标记下;
# 1.1 Vben Form 表单
框架提供的表单组件,可适配 Element Plus、Ant Design Vue、Naive UI 等框架。支持表单验证、表单联动、自定义组件等功能。
- 官方文档:Vben Form 表单 (opens new window)
- 源码位置:
@vben/common-ui中的useVbenForm - 实战案例:
# 1.2 Vben Modal 模态框
框架提供的模态框组件,支持拖拽、全屏、自动高度、loading 等功能。
- 官方文档:Vben Modal 模态框 (opens new window)
- 源码位置:
@vben/common-ui中的useVbenModal - 实战案例:
# 1.3 Vben Drawer 抽屉
框架提供的抽屉组件,类似 Modal 但以侧边栏形式展示。
- 官方文档:Vben Drawer 抽屉 (opens new window)
- 源码位置:
@vben/common-ui中的useVbenDrawer - 实战案例:
# 1.4 Vben Vxe Table 表格
框架提供的 Table 列表组件,基于 vxe-table,结合 Vben Form 表单进行了二次封装,支持树形结构。
- 官方文档:Vben Vxe Table 表格 (opens new window)
- 源码位置:
@vben/common-ui中的useVbenVxeTable - 实战案例(单表):
- 实战案例(树形):
# 1.5 Vben Alert 轻量提示框
框架提供的一些用于轻量提示的弹窗,仅使用 js 代码即可快速动态创建提示,而不需要在 template 写任何代码。
- 官方文档:Vben Alert 轻量提示框 (opens new window)
- 源码位置:
@vben/common-ui中的VbenAlert - 实战案例:
ps:confirm 使用的相对多,alert 还是基本使用 antd、ele 自带的。
# 1.6 Vben ApiComponent API 组件包装器
框架提供的 API “包装器”,它一般不独立使用,主要用于包装其它组件,为目标组件提供自动获取远程数据的能力,但仍然保持了目标组件的原始用法。
- 官方文档:Vben ApiComponent (opens new window)
- 源码位置:
@vben/common-ui中的ApiComponent - 实战案例(ApiSelect):
- antd:TODO 从 vben-v5 项目里找下
- ele:TODO 从 vben-v5 项目里找下
- 实战案例(ApiTreeSelect):
- antd:TODO 从 vben-v5 项目里找下
- ele:TODO 从 vben-v5 项目里找下
# 1.7 Description 描述列表
用于展示详情信息的组件,支持多列布局。
- 源码位置:
- antd:
apps/web-antd/src/components/description - ele:
apps/web-ele/src/components/description
- antd:
- 实战案例:
apps/web-antd/src/views/system/user/UserDetail.vueapps/web-ele/src/views/system/user/UserDetail.vue
TODO @AI:antd、ele 写下超链接;
TODO @AI:案例找的不对,找错了,去 vben-v5 找下;
# 1.8 OperateLog 操作日志
用于展示操作日志的组件。
- 源码位置:
apps/web-antd/src/components/operate-logapps/web-ele/src/components/operate-log
- 实战案例:
# 1.9 TableAction 表格操作
表格行操作按钮组件,用于展示编辑、删除等操作按钮。
- 源码位置:
apps/web-antd/src/components/table-actionapps/web-ele/src/components/table-action
- 实战案例:
# 1.10 Upload 上传
文件上传组件,支持单文件、多文件、图片上传等。
- 源码位置:
apps/web-antd/src/components/uploadapps/web-ele/src/components/upload
- 实战案例(单文件):
- 实战案例(多文件):
【done】TODO @AI:案例找的不对,每个 upload 组件,都需要找一个;然后传递 1 个,和多个,都要找;
# 1.11 TinyMCE 富文本编辑器
基于 TinyMCE 的富文本编辑器组件。
- 源码位置:
apps/web-antd/src/components/tinymceapps/web-ele/src/components/tinymce
- 实战案例:
# 2. 不常用组件
# 2.1 Vben CountToAnimator 数字动画
数字动画组件,用于展示数字的动画效果。
- 官方文档:Vben CountToAnimator (opens new window)
- 源码位置:
@vben/common-ui中的CountToAnimator - 实战案例:
# 2.2 Vben EllipsisText 省略文本
文本省略组件,用于展示超长文本。
- 官方文档:Vben EllipsisText (opens new window)
- 源码位置:
@vben/common-ui中的EllipsisText - 实战案例:
# 2.3 MarkdownView Markdown 预览
Markdown 内容预览组件。
- 源码位置:
apps/web-antd/src/components/markdown-viewapps/web-ele/src/components/markdown-view
- 实战案例:
# 2.4 ShortcutDateRangePicker 快捷日期范围选择
快捷日期范围选择组件,提供预设的日期范围选项。
- 源码位置:
apps/web-antd/src/components/shortcut-date-range-pickerapps/web-ele/src/components/shortcut-date-range-picker
- 实战案例:
# 2.5 CronTab Cron 表达式编辑
Cron 表达式可视化编辑组件。
- 源码位置:
apps/web-antd/src/components/cron-tabapps/web-ele/src/components/cron-tab
- 实战案例:
# 2.6 Cropper 图片裁剪
图片裁剪组件,支持旋转、缩放等操作。
- 源码位置:
apps/web-antd/src/components/cropperapps/web-ele/src/components/cropper
- 实战案例:
# 2.7 form-create 动态表单生成器
动态表单生成器,支持通过 JSON 配置生成表单。
- 官方文档:form-create (opens new window)
- 源码位置:
apps/web-antd/src/components/form-createapps/web-ele/src/components/form-create
- 实战案例:
# 2.8 bpmn-js 工作流组件
基于 bpmn-js 的工作流设计和展示组件。
- 官方文档:bpmn-js (opens new window)
- 源码位置:
apps/web-antd/src/components/bpmnProcessDesignerapps/web-ele/src/components/bpmnProcessDesigner
- 实战案例: