Pro Helper 工具

Pro 组件共享的对象读写、格式化和选项转换工具集合。

基础示例

示例使用本地演示数据；上传、校验和提交不会连接业务后端。

项目名称：IDX Web

负责人：Docs

<script setup lang="ts">
import { getProp, setProp } from "@/components/pro/helper";

const model = { project: { name: "IDX Web" } };
setProp(model, "project.owner", "Docs");
</script>

<template>
  <div class="demo-surface">
    <p>项目名称：{{ getProp(model, "project.name") }}</p>
    <p>负责人：{{ getProp(model, "project.owner") }}</p>
  </div>
</template>

隐藏源代码

引入方式

import {
  lastProp,
  getProp,
  setProp,
  deleteProp,
  toCamelCase,
  formatValue,
  filterOptions,
  findItemNested,
  filterOptionsValue,
  getObjectKeys,
  filterEmpty,
  flatColumnsFn,
} from "@/components/pro/helper";

Props

参数	说明	类型	默认值	必填
-	该组件未声明 Props。	-	-	-

Events

事件名	说明	回调参数
-	该组件未声明 Events。	-

Slots

插槽名	说明	参数
-	该组件未声明 Slots。	-

Expose

名称	说明	类型
-	该组件未声明 Expose。	-

Module API

名称	说明	类型
lastProp	处理 prop，当 prop 为多级嵌套时，返回最后一级 prop	(prop: string) => unknown
getProp	处理 prop 为多级嵌套的情况，返回的数据 (列如: prop: user.name)	(model: unknown, prop: NonNullable<FormItemColumnProps["prop"]>, valueFormat?: FormItemColumnProps["valueFormat"]) => unknown
setProp	对 model 对象的 pro 赋值	(model: unknown, prop: NonNullable<FormItemColumnProps["prop"]>, value: unknown) => unknown
deleteProp	删除对象中的属性，包括嵌套属性	(obj: unknown, propPath: string) => boolean
toCamelCase	将连字符转换为大驼峰格式	(val?: string) => unknown
formatValue	格式化值	(value: | T<br> | Promise<T><br> | Ref<T><br> | Reactive<T><br> | ComputedRef<T><br> | FormatValueGetter<T>, params: Recordable, processRef: unknown) => Promise<unknown>
filterOptions	根据枚举列表查询当需要的数据(如果指定了 value 的 key 值,会自动识别格式化)	(modelValue: unknown, options: Recordable[], optionField?: FormItemColumnProps["optionField"]) => unknown
findItemNested	递归查找 callValue 对应的 options 值	(modelValue: unknown, options: Recordable[], value: string, children: string) => Recordable | null
filterOptionsValue	根据枚举列表查询当需要的 label 数据	(options: Recordable | Recordable[], keyName: unknown, defaultValue: unknown) => unknown
getObjectKeys	获取对象中所有叶子节点的路径（多级路径用 . 拼接） 假设 假设 model 为 { user: { age: {name: ""} }, menu: "" }，如果获取为 ["user.age.name", "menu"]	(model: Recordable, prefix: unknown) => string[]
filterEmpty	过滤对象中为空值的属性	(obj: T) => unknown
flatColumnsFn	扁平化 columns	(columns: T[], flatArr: T[], key: unknown) => unknown

API 根据当前组件源码生成；同步版本与验证记录见维护说明。