导出清单

本文档列出 vue-admin-kit 包导出的所有方法、变量和类型。

组件

核心组件

导出名	类型	说明
`PageTemplate`	组件	核心 CRUD 页面模板组件
`Table`	组件	VXE-Table 封装的表格组件
`Descriptions`	组件	数据展示组件
`SearchForm`	组件	搜索表单组件

弹窗组件

导出名	类型	说明
`FormDialog`	组件	表单弹窗组件
`DetailDialog`	组件	详情弹窗组件
`Drawer`	组件	抽屉组件
`FileListDialog`	组件	文件列表弹窗组件

表单控件

导出名	类型	说明
`Input`	组件	输入框控件
`InputGroup`	组件	输入框组控件
`AddableInputGroup`	组件	可添加的输入框组
`Number`	组件	数字输入框控件
`Select`	组件	选择器控件
`SelectChange`	组件	联动选择器控件
`Radio`	组件	单选框控件
`Date`	组件	日期选择器控件
`Time`	组件	时间选择器控件
`Textarea`	组件	文本域控件
`Upload`	组件	文件上传控件
`UploadCard`	组件	卡片式上传控件
`WangeEitor`	组件	富文本编辑器控件
`Line`	组件	分割线控件
`SafeHtml`	组件	安全 HTML 渲染控件

辅助组件

导出名	类型	说明
`DictTag`	组件	字典标签组件
`DictHelper`	组件	字典辅助组件

Hooks

状态管理

导出名	类型	说明
`useState`	Hook	页面状态管理 Hook
`useDialog`	Hook	对话框状态管理 Hook
`usePackageAppConfig`	Hook	用户偏好设置 Hook
`usePageTemplateConfig`	Hook	全局配置获取 Hook

字典相关

导出名	类型	说明
`useDict`	Hook	字典数据获取 Hook
`useDictReactive`	Hook	响应式字典数据 Hook
`useDictLabel`	Hook	获取字典标签 Hook
`useDictOptions`	Hook	获取字典选项 Hook
`useDictTagType`	Hook	获取字典标签类型 Hook

表格相关

导出名	类型	说明
`useTableHeight`	Hook	表格高度管理 Hook
`useTableHeightEmitter`	Hook	表格高度事件发射器

操作辅助

导出名	类型	说明
`useConfirmAction`	Hook	确认操作 Hook

工具函数

配置定义函数

导出名	类型	说明
`defineSearchConfig`	函数	定义搜索配置（类型安全）
`defineFormConfig`	函数	定义表单配置（类型安全）
`defineColumnsConfig`	函数	定义列配置（类型安全）
`defineOptionsColumns`	函数	定义操作列配置
`defineApiConfig`	函数	定义 API 配置（类型安全）
`definePermissions`	函数	定义权限配置（类型安全）
`defineTableOperations`	函数	定义表格工具栏操作
`defineOperateColumns`	函数	定义行操作按钮
`defineDescriptionsConfig`	函数	定义描述列表配置

列配置工具

导出名	类型	说明
`col`	函数	创建列配置项
`getColumnConfig`	函数	获取已注册的列配置
`withUnit`	函数	为列添加单位格式化
`baseColumnConfigs`	对象	基础列配置集合
`registerColumnConfig`	函数	注册单个列配置
`registerColumnConfigs`	函数	批量注册列配置
`clearColumnConfigs`	函数	清空列配置

表单配置工具

导出名	类型	说明
`formCol`	函数	创建表单配置项
`getFormConfig`	函数	获取已注册的表单配置
`baseFormConfigs`	对象	基础表单配置集合
`registerFormConfig`	函数	注册单个表单配置
`registerFormConfigs`	函数	批量注册表单配置
`clearFormConfigs`	函数	清空表单配置

搜索配置工具

导出名	类型	说明
`searchCol`	函数	创建搜索配置项
`getSearchConfig`	函数	获取已注册的搜索配置
`baseSearchConfigs`	对象	基础搜索配置集合
`registerSearchConfig`	函数	注册单个搜索配置
`registerSearchConfigs`	函数	批量注册搜索配置
`clearSearchConfigs`	函数	清空搜索配置

条件显示函数

导出名	类型	说明
`showWhen`	函数	单条件显示（字段等于某值）
`showWhenIn`	函数	多值匹配显示（字段在数组中）
`showAll`	函数	AND 组合（所有条件满足）
`showAny`	函数	OR 组合（任一条件满足）

操作辅助工具

导出名	类型	说明
`confirmAction`	函数	确认操作函数
`createStatusToggle`	函数	创建状态切换函数

响应处理工具

导出名	类型	说明
`formatterRes`	函数	格式化单条响应数据
`formatterListRes`	函数	格式化列表响应数据
`checkRes`	函数	检查响应结果

验证工具

导出名	类型	说明
`isPathMatch`	函数	路径匹配检查
`isHttp`	函数	HTTP 链接检查
`isExternal`	函数	外部链接检查
`validURL`	函数	URL 格式验证
`validEmail`	函数	邮箱格式验证
`validPhone`	函数	手机号格式验证
`validLowerCase`	函数	小写字母验证
`validUpperCase`	函数	大写字母验证
`validAlphabets`	函数	字母验证
`isString`	函数	字符串类型检查
`isArray`	函数	数组类型检查
`isEmpty`	函数	空值检查
`isNotEmpty`	函数	非空检查

文件工具

导出名	类型	说明
`downloadFile`	函数	文件下载
`handleFileChangeExcel`	函数	Excel 文件选择处理

权限工具

导出名	类型	说明
`vHasPermi`	指令	权限检查指令
`vHasRole`	指令	角色检查指令
`configurePermissionDirective`	函数	配置权限指令
`registerPermissionDirectives`	函数	注册权限指令
`hasPermission`	函数	编程式权限检查
`hasRole`	函数	编程式角色检查

字典管理

导出名	类型	说明
`DictManager`	类	字典管理器类
`getDictManager`	函数	获取字典管理器实例
`resetDictManager`	函数	重置字典管理器
`getCustomAdapter`	函数	获取自定义适配器
`getAllCustomAdapters`	函数	获取所有自定义适配器
`hasCustomAdapter`	函数	检查是否有自定义适配器
`getDictLabel`	函数	获取字典标签（同步）
`getDictLabels`	函数	获取多个字典标签
`preloadDicts`	函数	预加载字典
`clearDictCache`	函数	清空字典缓存
`isDictLoaded`	函数	检查字典是否已加载
`areDictsLoaded`	函数	检查多个字典是否已加载
`isDictDataOption`	函数	类型守卫：检查是否为字典数据选项
`isDictLoadResult`	函数	类型守卫：检查是否为字典加载结果

DOM 工具

导出名	类型	说明
`isElementVisible`	函数	检查 DOM 元素是否可见（支持 v-show 场景）

全局配置

导出名	类型	说明
`setupPageTemplate`	函数	初始化 PageTemplate 配置
`providePageTemplateConfig`	函数	提供 PageTemplate 配置
`usePageTemplateConfig`	函数	使用 PageTemplate 配置
`resetPageTemplateConfig`	函数	重置 PageTemplate 配置

默认导出

导出名	类型	说明
`default`	插件	Vue 插件，包含 `install` 方法

类型导出

以下类型通过 export type 从包中导出，可直接导入使用。

全局配置类型

类型名	说明
`PageTemplateConfig`	PageTemplate 全局配置
`PageTemplateDependencies`	依赖配置
`PageTemplateDictOptions`	字典配置选项
`PageTemplateUIOptions`	UI 配置选项
`FormItemSizeType`	表单项尺寸类型

组件配置类型

类型名	说明
`SearchConfigItem`	搜索配置项
`FormConfigItem`	表单配置项
`FormDialogConfigItem`	表单弹窗配置项
`ColumnConfigItem`	列配置项
`PermissionConfig`	权限配置
`BaseConfigItem`	基础配置项
`SelectComponentDictType`	选择器字典类型
`SelectType`	选择器类型
`RadioComponentDictType`	单选框字典类型
`UploadComponent`	上传组件配置
`SelectChangeConfig`	联动选择器配置
`PageTemplateExposed`	PageTemplate 暴露的方法

useState Hook 类型

类型名	说明
`ConfigOptions`	配置选项
`UseStateOptions`	useState 选项
`UseStateHandlers`	useState 处理器
`UseStateLogger`	useState 日志器
`UseStateErrorContext`	错误上下文
`UseStateSuccessContext`	成功上下文

Table 组件类型

类型名	说明
`TableColumn`	表格列配置
`OperateColumnBase`	操作列基础配置
`OperateColumn`	操作列配置
`TableOptions`	表格选项
`VxeGridType`	VXE-Grid 类型
`pageDataType`	页面数据类型

字典相关类型

类型名	说明
`ElTagType`	Element Plus Tag 类型
`DictDataOption`	字典数据选项
`DictLoadOptions`	字典加载选项
`DictLoadResult`	字典加载结果
`DictStoreState`	字典存储状态
`DictStoreStats`	字典存储统计
`DictConfig`	字典配置
`DictAdapterConfig`	字典适配器配置
`DictApiMap`	字典 API 映射
`DictTypeConstants`	字典类型常量

Descriptions 组件类型

类型名	说明
`DescriptionItemType`	描述项类型
`DescriptionItemConfig`	描述项配置
`DescriptionSectionConfig`	描述分组配置
`FileItem`	文件项

API 相关类型

类型名	说明
`ApiResponse`	API 响应类型
`OssUploadResult`	OSS 上传结果
`OssApi`	OSS API 接口
`ComponentLibraryApis`	组件库 API 集合

Hook 相关类型

类型名	说明
`UseDialogOptions`	useDialog 选项
`UseDialogReturn`	useDialog 返回值
`ConfirmOptions`	确认操作选项
`CheckResOptions`	checkRes 选项
`TableHeightState`	表格高度状态
`UseTableHeightOptions`	useTableHeight 选项

指令相关类型

类型名	说明
`PermissionGetter`	权限获取器
`RoleGetter`	角色获取器
`PermissionDirectiveConfig`	权限指令配置

内部类型

以下类型在 src/types/index.ts 中定义但未从包入口导出，仅供内部使用或通过 types/index.d.ts 访问：

基础类型：SizeType、ButtonType、LabelPosition、Direction、Logger
配置类型：CalculateHeightFn、InternalConfig
组件类型：SelectComponentOptions、RadioComponentOptions、FormVisibilityContext
useState 类型：ActionType、WrappedConfig、MaybeConfig、ParamsProvider
Table 类型：OperateColumnDropdown、PaginationConfig、QueryParams、ApiConfig
Hook 类型：ConfirmType
标签类型：TagType、TagItem、TagData、TagConfig