3eb8cc0614
补全方法的参数类型、返回值类型与详情说明，规范字段编辑器/字段配置/运行时 API 等文档。 Co-authored-by: Cursor <cursoragent@cursor.com>
2.9 KiB
Form组件属性 props
config
-
详情： 表单配置
-
默认值：
[] -
类型： FormConfig
-
示例：
<template>
<m-form-dialog :config="config"></m-form-dialog>
</template>
<script setup>
import { ref } from "Vue";
const config = ref([
{
name: "text",
text: "文本",
},
{
name: "multiple",
text: "多行文本",
type: "switch",
},
]);
</script>
initValues
-
详情： 表单初始化值
-
默认值：
{} -
类型：
Object -
示例：
<template>
<m-form-dialog :init-values="initValues"></m-form-dialog>
</template>
<script setup>
import { ref } from 'Vue';
const initValues = ref([
text: 'text',
multiply: true,
]);
</script>
lastValues
-
详情： 需对比的值（开启对比模式时传入）
-
默认值：
{} -
类型：
Object
isCompare
-
详情： 是否开启对比模式
-
默认值：
false -
类型：
boolean
parentValues
-
详情： 父级表单值
-
默认值：
{} -
类型：
Object
labelWidth
- 详情：
表单域标签的宽度，例如 '50px'。 作为 Form 直接子元素的 form-item 会继承该值。 支持 auto
-
默认值：
'200px' -
类型：
string
disabled
-
详情： 是否禁用该表单内的所有组件。 若设置为 true，则表单内组件上的 disabled 属性不再生效
-
默认值： false
-
类型：
boolean
height
-
详情： 表单容器的高度，会作为内联样式
height应用到表单根元素上 -
默认值：
'auto' -
类型：
string
stepActive
-
详情： 当表单包含 step 容器时，控制当前激活的步骤
-
默认值：
1 -
类型：
string | number
size
-
详情： 用于控制该表单内组件的尺寸
-
类型：
'small' | 'default' | 'large'
inline
-
详情： 行内表单模式
-
默认值： false
-
类型：
boolean
labelPosition
-
详情： 表单域标签的位置， 当设置为 left 或 right 时，则也需要设置 label-width 属性
-
默认值：
'right' -
类型：
string
keyProp
-
详情： 作为表单项的组件实例的key
-
默认值：
'__key' -
类型：
string
popperClass
-
详情： tooltip弹出层的class
-
类型：
string
preventSubmitDefault
-
详情： 是否阻止表单原生 submit 事件的默认行为
-
类型：
boolean
extendState
-
详情： 扩展 formState 的钩子函数，返回的对象会被合并到 formState 上
-
类型：
(state: FormState) => Record<string, any> | Promise<Record<string, any>>