diff --git a/docs/en-US/component/form.md b/docs/en-US/component/form.md index ad9ae76cb9..3f720c7795 100644 --- a/docs/en-US/component/form.md +++ b/docs/en-US/component/form.md @@ -127,24 +127,24 @@ form/accessibility ### Form Attributes -| Name | Description | Type | Default | -| --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------- | -| model | Data of form component. | ^[object]`Record` | — | -| rules | Validation rules of form. | ^[object]`FormRules` | — | -| inline | Whether the form is inline. | ^[boolean] | false | -| label-position | Position of label. If set to `'left'` or `'right'`, `label-width` prop is also required. | ^[enum]`'left' \| 'right' \| 'top'` | right | -| label-width | Width of label, e.g. `'50px'`. All its direct child form items will inherit this value. `auto` is supported. | ^[string] / ^[number] | '' | -| label-suffix | Suffix of the label. | ^[string] | '' | -| hide-required-asterisk | Whether to hide required fields should have a red asterisk (star) beside their labels. | ^[boolean] | false | -| require-asterisk-position | Position of asterisk. | ^[enum]`'left' \| 'right'` | left | -| show-message | Whether to show the error message. | ^[boolean] | true | -| inline-message | Whether to display the error message inline with the form item. | ^[boolean] | false | -| status-icon | Whether to display an icon indicating the validation result. | ^[boolean] | false | -| validate-on-rule-change | Whether to trigger validation when the `rules` prop is changed. | ^[boolean] | true | -| size | Control the size of components in this form. | ^[enum]`'' \| 'large' \| 'default' \| 'small'` | — | -| disabled | Whether to disable all components in this form. If set to `true`, it will override the `disabled` prop of the inner component. | ^[boolean] | false | -| scroll-to-error | When validation fails, scroll to the first error form entry. | ^[boolean] | false | -| scroll-into-view-options ^(2.3.2) | When validation fails, it scrolls to the first error item based on the scrollIntoView option. [scrollIntoView](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). | ^[object]`ScrollIntoViewOptions` / ^[boolean] | true | +| Name | Description | Type | Default | +| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------- | +| model | Data of form component. | ^[object]`Record` | — | +| rules | Validation rules of form. | ^[object]`FormRules` | — | +| inline | Whether the form is inline. | ^[boolean] | false | +| label-position | Position of label. If set to `'left'` or `'right'`, `label-width` prop is also required. | ^[enum]`'left' \| 'right' \| 'top'` | right | +| label-width | Width of label, e.g. `'50px'`. All its direct child form items will inherit this value. `auto` is supported. | ^[string] / ^[number] | '' | +| label-suffix | Suffix of the label. | ^[string] | '' | +| hide-required-asterisk | Whether to hide required fields should have a red asterisk (star) beside their labels. | ^[boolean] | false | +| require-asterisk-position | Position of asterisk. | ^[enum]`'left' \| 'right'` | left | +| show-message | Whether to show the error message. | ^[boolean] | true | +| inline-message | Whether to display the error message inline with the form item. | ^[boolean] | false | +| status-icon | Whether to display an icon indicating the validation result. | ^[boolean] | false | +| validate-on-rule-change | Whether to trigger validation when the `rules` prop is changed. | ^[boolean] | true | +| size | Control the size of components in this form. | ^[enum]`'' \| 'large' \| 'default' \| 'small'` | — | +| disabled | Whether to disable all components in this form. Before ^(2.12.0), if set to `true`, it will override the `disabled` prop of the inner component. After ^(2.12.0), the configuration of the internal components takes precedence. | ^[boolean] | false | +| scroll-to-error | When validation fails, scroll to the first error form entry. | ^[boolean] | false | +| scroll-into-view-options ^(2.3.2) | When validation fails, it scrolls to the first error item based on the scrollIntoView option. [scrollIntoView](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView). | ^[object]`ScrollIntoViewOptions` / ^[boolean] | true | ### Form Events