跳到正文

组件辅助导出 ​

formUtil.validate(ref) 与 formUtil.validateScrollToField(ref) 校验成功时 Promise 以 true 完成。从 2.0.16 起,校验失败时以 Element Plus 的 invalidFields 详情拒绝,需通过 catch 处理,并非返回一个成功完成的 false。实例尚未挂载时仍以 Error 拒绝。FaForm.validate()(不传回调)与 FaForm.validateScrollToField() 遵循相同约定;FaForm.validate(callback) 保持 Element Plus 原生回调行为。

分类运行时导出用途
PropsfaAvatarProps、faButtonProps、faDialogProps、faDrawerProps、faFormProps、faFormItemProps、faFormItemTipProps、faIconProps、faImageProps、faInputDialogPageProps、faSelectProps、faSelectPageProps、faSelectV2Props、faTableProps、faTreeProps、faTreeSelectProps、faUploadProps、faUploadImageProps、faUploadImagesProps复用组件运行时 Props 定义
EmitsfaAvatarEmits、faButtonEmits、faDialogEmits、faDrawerEmits、faFormEmits、faImageEmits、faInputDialogPageEmits、faSelectPageEmits、faTableEmits、faTreeEmits、faTreeSelectEmits、faUploadEmits、faUploadImageEmits、faUploadImagesEmits复用组件运行时 Emits 校验
表格原生定义tableProps、tableColumnProps当前封装采用的 Element Plus 表格 Props 基线
表格工具PagedSearchTypeEnum、getTableDefaultSlots、formUtil、tableUtil分页条件、插槽数据和表格业务辅助能力
选择器SelectV2PropsFaSelectV2 可复用的 Props 类型和值定义
车牌CarNumberArea、CarNumberDigit、CarNumberLetter车牌地区、数字和字母键盘数据

公开类型包括各组件的 Props、Emits、Slots、Instance、Exposes,以及 DefaultRow、ElSelectorValue、ElSelectorModelValue、ElSelectorOutput、ElTreeValue、ElTreeOutput、FaLayoutGridBreakpoint、FaTableColumnCtx、FaTableSearchColumnCtx、PagedInput、PagedResult 等业务数据类型。精确字段、泛型和可空性以根入口生成的 TypeScript 声明为准。

SDK 无法预知结构的业务数据默认使用 any。已知模型可通过 PagedResult<Output>、ElSelectorOutput<Value, Data> 和 ElTreeOutput<Value, Data> 显式约束;未经验证的运行时输入、错误对象、反射结果和必须先收窄的值继续使用 unknown。

getTableDefaultSlots 默认插槽 ​

从 FaTable 状态中取得默认插槽共享的数据和操作。

签名 ​

ts
getTableDefaultSlots(state: FaTableState): FaTableDefaultSlotsResult;

示例 ​

ts
import { getTableDefaultSlots } from "fast-element-plus";

const result = getTableDefaultSlots(tableState);

输入 ​

输入值输入值类型必填/默认值输入值说明
stateFaTableState是FaTable 内部或组合式封装持有的表格状态。

返回 ​

返回值返回值类型返回值说明
resultFaTableDefaultSlotsResultLoading、搜索条件、选择状态和可选搜索方法组成的新对象。

自 2.0.28 起,PagedInput 声明可选只读字段 isOrderBy。服务端根据 sortList 计算是否可使用默认排序,构造分页请求时可以省略。