Browse Source

docs: fix form `compact` docs (#5811)

* docs: fix form `compact` docs

* docs: remove `compact` from FormCommonConfig
Netfan 5 months ago
parent
commit
e91e4e0eea
1 changed files with 1 additions and 7 deletions
  1. 1 7
      docs/src/components/common-ui/vben-form.md

+ 1 - 7
docs/src/components/common-ui/vben-form.md

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