常量与工具

• FaMimeType：上传 API 使用的文件 MIME 类型常量。
• RegExps：组件共享的正则表达式，包含中国大陆手机号、邮箱、弱/中/强密码、六位验证码和四位图片验证码等常用校验规则。
• Decimal：重新导出的 decimal.js 构造函数，可用于上传进度和消费端计算。

formUtil.validate 校验

调用已挂载 ElForm 的完整表单校验。

签名

validate(ref: Readonly<Ref<FormInstance | null | undefined>>): FormValidationResult;

示例

import { ref } from "vue";
import { formUtil } from "fast-element-plus";
import type { FormInstance } from "element-plus";

const formRef = ref<FormInstance>();
const result = await formUtil.validate(formRef);

输入

输入值	输入值类型	必填/默认值	输入值说明
ref	Readonly<Ref<FormInstance | null | undefined>>	是	ElForm 实例引用。

返回

返回值	返回值类型	返回值说明
result	FormValidationResult	有效时以 true 完成；无效时以 invalidFields 拒绝，未挂载时以 Error 拒绝。

formUtil.validateScrollToField 校验

校验表单并在失败时滚动到无效字段。

签名

validateScrollToField(ref: Readonly<Ref<FormInstance | null | undefined>>): FormValidationResult;

示例

const result = await formUtil.validateScrollToField(formRef);

输入

输入值	输入值类型	必填/默认值	输入值说明
ref	Readonly<Ref<FormInstance | null | undefined>>	是	ElForm 实例引用。

返回

返回值	返回值类型	返回值说明
result	FormValidationResult	有效时以 true 完成；无效时滚动并以 invalidFields 拒绝。

formUtil.mobile 校验

Element Plus 表单规则回调：校验必填中国大陆手机号。

签名

mobile(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.mobile({} as FormItemRule, "13800138000", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的必填中国大陆手机号。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.phone 校验

Element Plus 表单规则回调：校验可选固定电话号码。

签名

phone(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.phone({} as FormItemRule, "010-12345678", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的可选固定电话号码。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.email 校验

Element Plus 表单规则回调：校验可选邮箱。

签名

email(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.email({} as FormItemRule, "user@example.com", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的可选邮箱。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.idCard 校验

Element Plus 表单规则回调：校验可选身份证号。

签名

idCard(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.idCard({} as FormItemRule, "11010519491231002X", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的可选身份证号。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.carNumber 校验

Element Plus 表单规则回调：校验七位或八位车牌号。

签名

carNumber(rule: FormItemRule, value: string | null | undefined, callback: (error?: Error) => void): void;

示例

formUtil.carNumber({} as FormItemRule, "京A12345", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string | null | undefined	是	需要校验的七位或八位车牌号。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.editorRequired 校验

Element Plus 表单规则回调：校验富文本必填值。

签名

editorRequired(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.editorRequired({} as FormItemRule, "<p>正文</p>", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的富文本必填值。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.external 校验

Element Plus 表单规则回调：校验外部链接。

签名

external(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.external({} as FormItemRule, "https://example.com", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的外部链接。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.url 校验

Element Plus 表单规则回调：校验有效 URL。

签名

url(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.url({} as FormItemRule, "https://example.com/path", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的有效 URL。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.postCode 校验

Element Plus 表单规则回调：校验邮政编码。

签名

postCode(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.postCode({} as FormItemRule, "100000", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的邮政编码。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.account 校验

Element Plus 表单规则回调：校验6 至 20 位账号。

签名

account(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.account({} as FormItemRule, "fast123", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的6 至 20 位账号。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.password 校验

Element Plus 表单规则回调：校验6 至 18 位弱密码。

签名

password(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.password({} as FormItemRule, "fast1234", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的6 至 18 位弱密码。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.strongPassword 校验

Element Plus 表单规则回调：校验8 至 20 位强密码。

签名

strongPassword(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.strongPassword({} as FormItemRule, "Fast@1234", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的8 至 20 位强密码。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.chinese 校验

Element Plus 表单规则回调：校验中文字符。

签名

chinese(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.chinese({} as FormItemRule, "中文", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的中文字符。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.english 校验

Element Plus 表单规则回调：校验英文字符。

签名

english(rule: FormItemRule, value: string, callback: (error?: Error) => void): void;

示例

formUtil.english({} as FormItemRule, "Fast", (error) => {
	if (error) console.error(error.message);
});

输入

输入值	输入值类型	必填/默认值	输入值说明
rule	FormItemRule	是	Element Plus 传入的规则对象；当前校验器不读取其字段。
value	string	是	需要校验的英文字符。
callback	(error?: Error) => void	是	成功时无参调用，失败时传入 Error。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值；校验结果通过 callback 报告。

formUtil.inputRequired 校验

创建文本输入必填规则。

签名

inputRequired(message: string, trigger?: string): FormItemRule;

示例

const result = formUtil.inputRequired("此项必填", "blur");

输入

输入值	输入值类型	必填/默认值	输入值说明
message	string	是	校验失败提示。
trigger	string	否，默认 blur	触发校验的事件名。

返回

返回值	返回值类型	返回值说明
result	FormItemRule	包含 required、message 和 trigger 的 Element Plus 规则对象。

formUtil.selectRequired 校验

创建选择器必选规则。

签名

selectRequired(message: string, trigger?: string): FormItemRule;

示例

const result = formUtil.selectRequired("此项必填", "change");

输入

输入值	输入值类型	必填/默认值	输入值说明
message	string	是	校验失败提示。
trigger	string	否，默认 change	触发校验的事件名。

返回

返回值	返回值类型	返回值说明
result	FormItemRule	包含 required、message 和 trigger 的 Element Plus 规则对象。

tableUtil.formatValue 格式化

把数组单元格连接为文本，并规范空数组。

签名

formatValue(value: unknown): unknown;

示例

const result = tableUtil.formatValue(["A", "B"]);

输入

输入值	输入值类型	必填/默认值	输入值说明
value	unknown	是	当前单元格值。

返回

返回值	返回值类型	返回值说明
result	unknown	数组连接文本、空数组为 null，其他值原样返回。

tableUtil.handleRowAccordingToProp 取值

按点分隔路径读取嵌套行字段。

签名

handleRowAccordingToProp(row: DefaultRow, prop: string): unknown;

示例

const result = tableUtil.handleRowAccordingToProp({ user: { name: "Fast" } }, "user.name");

输入

输入值	输入值类型	必填/默认值	输入值说明
row	DefaultRow	是	当前表格行。
prop	string	是	字段名或点分隔路径。

返回

返回值	返回值类型	返回值说明
result	unknown	目标字段值；路径中断时为 undefined。

tableUtil.handleProp 取值

取得点分隔字段路径的最后一段。

签名

handleProp(prop: string): string;

示例

const result = tableUtil.handleProp("user.name");

输入

输入值	输入值类型	必填/默认值	输入值说明
prop	string	是	字段路径。

返回

返回值	返回值类型	返回值说明
result	string	最后一级字段名。

tableUtil.filterEnum 枚举

从表格枚举列表查找标签或 Tag 类型。

签名

filterEnum(value: unknown, enumData: FaTableEnumColumnCtx[], fieldNames?: { label: string; value: string }, type?: "tag"): unknown;

示例

const result = tableUtil.filterEnum(1, [{ label: "启用", value: 1, type: "success" }]);

输入

输入值	输入值类型	必填/默认值	输入值说明
value	unknown	是	当前单元格值。
enumData	FaTableEnumColumnCtx[]	是	候选枚举列表。
fieldNames	{ label: string; value: string }	否	自定义标签和值字段。
type	"tag"	否	传入 tag 时返回枚举 Tag 类型。

返回

返回值	返回值类型	返回值说明
result	unknown	匹配标签、Tag 类型或未匹配时的 null/info。

tableUtil.arrayDynamicSort 排序

根据分页排序条件创建多字段比较器。

签名

arrayDynamicSort(sortList: PagedSortInput[]): (a: DefaultRow, b: DefaultRow) => number;

示例

const compare = tableUtil.arrayDynamicSort([{ enField: "name", mode: "ascending" }]);
const result = rows.toSorted(compare);

输入

输入值	输入值类型	必填/默认值	输入值说明
sortList	PagedSortInput[]	是	按优先顺序排列的字段与升降序条件。

返回

返回值	返回值类型	返回值说明
result	(a: DefaultRow, b: DefaultRow) => number	可传给 Array 排序方法的比较器。

tableUtil.setEnumMap 枚举

把静态或工厂枚举写入表格枚举 Map。

签名

setEnumMap(columnEnum: FaTableEnumColumnType, prop: string, enumMap: Map<string, FaTableEnumColumnCtx[]>): void;

示例

const enumMap = new Map();
tableUtil.setEnumMap([{ label: "启用", value: 1 }], "status", enumMap);

输入

输入值	输入值类型	必填/默认值	输入值说明
columnEnum	FaTableEnumColumnType	是	枚举名、枚举数组或枚举工厂。
prop	string	是	Map 使用的列字段键。
enumMap	Map<string, FaTableEnumColumnCtx[]>	是	需要更新的表格枚举 Map。

返回

返回值	返回值类型	返回值说明
result	void	没有返回值。

tableUtil.flatColumns 列展开

递归展平表格列，并可同步收集枚举。

签名

flatColumns(columns: FaTableColumnCtx[], enumMap?: Map<string, FaTableEnumColumnCtx[]>): FaTableColumnCtx[];

示例

const result = tableUtil.flatColumns(columns, new Map());

输入

输入值	输入值类型	必填/默认值	输入值说明
columns	FaTableColumnCtx[]	是	可包含 _children 的列树。
enumMap	Map<string, FaTableEnumColumnCtx[]>	否	需要同步填充的枚举 Map。

返回

返回值	返回值类型	返回值说明
result	FaTableColumnCtx[]	只包含叶子列的展平数组。