跳到主要内容

组件总览

@vef-framework-react/components 是 VEF Framework 的 UI 组件库,基于 Ant Design 6.x 构建,并在此基础上扩展了布局原语、权限感知组件和表单集成工具。

组件分类

Ant Design 直通组件

大多数 Ant Design 组件直接从 antd 重新导出,可以完全按照 Ant Design 官方文档 使用,Props 和 API 完全一致。

组件说明
Button触发操作
Input文本输入框
Select下拉选择器
Table数据表格(含 VEF 增强)
Form数据录入表单(由 useForm 替代)
Modal对话框
DatePicker日期/日期范围选择器
TimePicker时间/时间范围选择器
Checkbox复选框
Radio单选框
Switch开关
Slider滑动输入条
Upload文件上传
Tree树形控件
TreeSelect树形选择器
Cascader级联选择
AutoComplete自动完成
Mentions提及
ColorPicker颜色选择器
Rate评分
Transfer穿梭框
Avatar头像
Badge徽标数
Tag标签
Tooltip文字提示
Popover气泡卡片
Popconfirm气泡确认框
Dropdown下拉菜单
Menu导航菜单
Tabs标签页
Collapse折叠面板
Card卡片
List列表
Descriptions描述列表
Statistic统计数值
Progress进度条
Spin加载中
Skeleton骨架屏
Alert警告提示
Result结果页
Empty空状态
Pagination分页
Steps步骤条
Timeline时间轴
Breadcrumb面包屑
Anchor锚点
Affix固钉
Divider分割线
Space间距
Flex弹性布局
Row / Col栅格布局
Splitter分割面板
Drawer抽屉
FloatButton悬浮按钮
Image图片(含预览)
Calendar日历
Carousel走马灯
QRCode二维码
Watermark水印
Tour漫游式引导
Segmented分段控制器
InputNumber数字输入框
Typography排版(Text / Title / Paragraph / Link)
ConfigProvider全局化配置

VEF 特有组件

以下组件是 VEF Framework 独有的,不属于 Ant Design。

组件说明
ActionButton内置异步 loading 和确认对话框的按钮
ActionGroup从配置数组渲染一组操作按钮
Bool多种展示形式的布尔值输入/展示组件
Grid支持折叠的响应式自动填充网格
Stack垂直 flex 堆叠布局
Center居中 flex 布局
ScrollArea自定义滚动条区域,支持滚动事件回调
Loader全屏或内联加载指示器
PermissionGate基于权限条件渲染子内容
IconButton带 Tooltip 的图标按钮
DynamicIcon通过名称字符串渲染 Lucide 图标
OperationButtonActionButton + PermissionGate 的组合
ChartECharts 封装
CodeHighlighter语法高亮代码块
Keyboard键盘快捷键展示

表单系统

VEF 使用基于 @tanstack/react-form 的类型安全表单系统替代 Ant Design 的 Form。详见 Form 文档。

安装

pnpm add @vef-framework-react/components

基础用法

import { Button, Table, ActionButton } from '@vef-framework-react/components';

所有组件均通过具名导出支持 Tree-shaking。