bichangxiong/ruoyi-plus-vben5
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix form compact docs (#5811)

Browse Source 
* docs: fix form `compact` docs

* docs: remove `compact` from FormCommonConfig
This commit is contained in:
Netfan 2025-03-28 16:15:35 +08:00 committed by GitHub
parent c2b5f6497d
commit e91e4e0eea
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/components/common-ui/vben-form.md
View File

@ -323,6 +323,7 @@ useVbenForm 返回的第二个参数，是一个对象，包含了一些表单
| schema | 表单项的每一项配置 | `FormSchema[]` | - | | schema | 表单项的每一项配置 | `FormSchema[]` | - |
| submitOnEnter | 按下回车健时提交表单 | `boolean` | false | | submitOnEnter | 按下回车健时提交表单 | `boolean` | false |
| submitOnChange | 字段值改变时提交表单(内部防抖，这个属性一般用于表格的搜索表单) | `boolean` | false | | submitOnChange | 字段值改变时提交表单(内部防抖，这个属性一般用于表格的搜索表单) | `boolean` | false |
| compact | 是否紧凑模式(忽略为校验信息所预留的空间) | `boolean` | false |
::: tip fieldMappingTime ::: tip fieldMappingTime
@ -365,13 +366,6 @@ export interface FormCommonConfig {
* 所有表单项的props * 所有表单项的props
*/ */
componentProps?: ComponentProps; componentProps?: ComponentProps;
/**
* 是否紧凑模式(移除表单底部为显示校验错误信息所预留的空间)。
* 在有设置校验规则的场景下，建议不要将其设置为true
* 默认为false。但用作表格的搜索表单时，默认为true
* @default false
*/
compact?: boolean;
/** /**
* 所有表单项的控件样式 * 所有表单项的控件样式
*/ */