Input · Form
Form
Form
- Rerender on demand, avoids unnecessary full-volume rendering, higher performance
- Easy to use, simple structure, avoids unnecessary hierarchical nesting
- Perfect accessibility support
- FormState / FieldState can also be easily obtained from outside the Form Provides an external method to operate inside the form: formApi / fieldApi
- Support for encapsulating custom components into form controls, and you can quickly access your team's components through the extension mechanism provided by Form (through
withField
HOC) - Support Form level / Field level assignment, verification (synchronous / asynchronous)
Field
Semi encapsulates all form field component (Input、Select、Checkbox、DatePicker etc.) with
Taking over their data flow (
When in use, you need to import from the Form (note: only the control imported from the Form has data synchronization)
withField
once.Taking over their data flow (
props.value
& props.onChange
)When in use, you need to import from the Form (note: only the control imported from the Form has data synchronization)
Supported Field Component
Input
,InputNumber
,TextArea
,Select
,Checkbox
,Radio
,RadioGroup
,Switch
,DatePicker
,TimePicker
,Slider
,InputGroup
,TreeSelect
,Cascader
,Rating
,AutoComplete
,Upload
,Label
,ErrorMessage
,Section
、TagInput
All mounted under Form and declared directly in<Form.Input />
and<Form.Select />
when used.
The Field level component provided by Form, its
value
(or other properties specified by valueKey
), onChange (or other callback functions specified by onKeyChangeFnName
)
Properties are hijacked by Form, soDemos
Various ways to declare form
Semi Form supports multiple writing at the same time.
Basic Usage
Add
field
property to each field component.
You can also set label
properties for each field, by default is the same as fieldlabel
can be passed in a string directly, or declared in the form of an object, configure extra
, required
, optional
and other attributes to deal with more complex scenariosOther declaration methods
When you need to get
formState
, formApi
, values
, etc. directly inside the Form structure, you can use the following writingVia render props
Via children function
declare children as a function that returns all field components
Via props.component
Pass the entire internal structure directly in the form through
component
attribute.All supported field components
Field binding syntax
Every Field component must have a
field
property. This is how the form manages the state of this field.
See the field syntax section below for additional details on what you can pass in for field.The field can be a simple string, can be contained
Below is an example of the field name and their mapping path in FormState
.
Or[]
String that supports multi-level nestingBelow is an example of the field name and their mapping path in FormState
Field | Resolution |
---|---|
username | formState.values.username |
user[0] | formState.values.user[0] |
siblings.1 | formState.values.siblings[1] |
siblings['2'] | formState.values.siblings[2] |
parents[0].name | formState.values.parents[0].name |
parents[1]['name'] | formState.values.parents[1].name |
Form layout
- Vertical Layout: Arrange each field vertically (By default)
Semi Design recommends a vertical layout.
- Horizontal Layout: Arrange each field horizontally
You can use the horizontal layout by setting
layout='horizontal'
- Label Position, Label Align
You can control the position of the label in the Field and the direction of text alignment by settinglabelPosition
,labelAlign
- A more complex layout.
You can also combine theRow
andCol
provided by theGrid
to arrange the form structure as you want.
wrapper Col / label Col
When you need to set a uniform layout for all Fields in a Form, you can set
wrapperCol
and labelCol
on the Form
to quickly generate the layout. No need to manually use Row
, Col
manual layout.wrapperCol
,labelCol
Property Configuration Reference Col componentsRemove automatically added Label
Form will automatically insert
If you want to keep the DOM structure consistent with the original component, you can use
Label
for Field control. If you don't need to automatically insert the Label module, you can turn off the automatic label insertion function by setting noLabel=true
in the Field (at this time, the Field still has the ability to automatically display ErrorMessage, so the DOM structure is still different from the original component)If you want to keep the DOM structure consistent with the original component, you can use
pure=true
. At this time, the DOM structure will not change except that the data flow is taken over (you need to be responsible for the rendering of ErrorMessage, and it cannot be used by formProps.wrapperCol property impact)Embedded Label
A Label can be inlined in a field control by setting labelPosition to
inset
. Components currently supporting this feature include Input
, InputNumber
, DatePicker
, TimePicker
, Select
, TreeSelect
, Cascader
, TagInput
Export Label, ErrorMessage use
When the built-in Label and ErrorMessage layout does not meet the business requirements, you need to combine the positions yourself, but you want to use the default styles of Label and ErrorMessage directly.
you can import them from the
For details of their API, refer to Label / ErrorMessage
you can import them from the
Form
module, and combine Form.Label
/ Form.ErrorMessage
by yourself.For details of their API, refer to Label / ErrorMessage
Use Form.Slot
When your custom component needs to maintain the same layout style as the Field component, you can place your custom component in
For the Slot property configuration, refer to Form.Slot
Form.Slot
labelWidth
, labelAlign
, wrapperCol
, labelCol
set on the Form component automatically acts on Form.Slot
For the Slot property configuration, refer to Form.Slot
Use helpText、extraText set prompt information
You can place custom prompt information through
Additional prompt information can be placed through
When
helpText
, and display it in the same block as the verification information (error). When both have values, the verification information will be displayed first.Additional prompt information can be placed through
extraText
. When the error message and prompt text need to appear at the same time, this configuration can be used. It is always displayed and located after helpText/errorWhen
validateStatus
is passed in, the UI style corresponding to the value of validateStatus will be displayed first. If not passed in, the internal verification status of the field shall prevail. By configuring
For example, when you want to display the extraText prompt information between the Label and Field component.
This attribute can be configured uniformly on the Form or individually on each Field. When passing in at the same time, the configuration of the Field shall prevail.
extraTextPosition
, you can control the display position of extraText. Optional values bottom
, middle
For example, when you want to display the extraText prompt information between the Label and Field component.
This attribute can be configured uniformly on the Form or individually on each Field. When passing in at the same time, the configuration of the Field shall prevail.
Using Input Group
When you need to combine some fields to use, you can use
In Semi Form, when you using field components like
But usually, in
Form.InputGroup
to wrap them.In Semi Form, when you using field components like
Form.Input
、Form.Select
, Form will insert Label module automatically for them.But usually, in
InputGroup
you only need a Label belonging to the entire Group.
You can set the label property in the InputGroup
to insert a Label belonging to the Grouplabel
configurable properties, see LabelForm in the Modal pop-up layer
You can place the Form in Modal and load it as a popup.
When submitting, use
When submitting, use
formApi.validate()
to centrally verify the FieldConfigure initial values and verification rules
- You can configure check rules for each Field through
rules
The verification library inside the Form is based onasync-validator
, and more configuration rules can be found in its official documentation - You can uniformly set the initial value for the entire form through the
initValues
of form, or you can set the initial value throughinitValue
in each field (the latter has a higher priority) - You can configure different verification trigger timings for each Field through
trigger
, and the default ischange
(that is, when onChange is triggered, the verification is performed automatically). Also supportschange
,blur
,mount
,custom
or a combination of the above. After v2.42, it supports unified configuration through FormProps. If both are configured, FieldProps shall prevail - You can use the `stopValidateWithError`` switch to decide whether to continue to trigger the validation of subsequent rules when the first rule that fails the validation is encountered. After v2.42, unified configuration through FormProps is supported. If both are configured, FieldProps shall prevail
Custom Validate (Form Level)
You can set a custom validation function validateFields for the
form
as a whole, which will be called when submitSynchronous Validate
When validate success, you should return an empty string.
When validate fails, you should return the error message (Object, key is fieldName, value is the corresponding error message)
When validate fails, you should return the error message (Object, key is fieldName, value is the corresponding error message)
Asynchronous Validate
For asynchronous validation, you should return a promise. In promise.then() you need to return the corresponding error message.
Custom Validate (Field Level)
You can specify a custom validation function for field. Supports synchronous and asynchronous validation (by returning promises)
Manually Trigger specified validation
When you want to manually trigger the validation of some specific Field, you can do it through
When no parameters are passed in, all Fields are checked by default. When parameters are passed in, the parameters specified shall prevail
formApi.validate
.When no parameters are passed in, all Fields are checked by default. When parameters are passed in, the parameters specified shall prevail
Linkage Fields
You can achieve the linkage between Fields by listening to the
onChange
of Field and then using formApi to make modifications.Dynamic form
Dynamically add and delete fields
ArrayField Usage
For array items that are dynamically added or deleted, we provide the
ArrayField
component to simplify the operation of add / removeFor the detailed API of ArrayField, please refer to ArrayField Props below
Note: The initValue type of ArrayField must be an array
Nesting ArrayField
ArrayField supports multi-level nesting. The following is an example of two-level nesting.
Add or delete form items dynamically - by use formApi
If you don't use ArrayField, you can use the provided formApi to manually add or delete formState.
Use of Hook
We provide four Hooks so that you can easily access Form internal state and call Form and Field related api in Functional Component which placed inside the Form structure without passing through props.
useFormApi
useFormApi
allows you to directly access the formApi of the parent Form component within Functional Component via hookuseFormState
useFormState
allows you to directly access the form State of the parent Form component within Functional Component via hookuseFieldApi
useFieldApi
allows you to call the api of the specified Field directly within Functional Component via hookuseFieldState
useFieldState
allows you to directly access the State of the specified Field within Functional Component via hookUse of HOC
We provided two HOC:
Provided HOC:
withFormApi
、withFormState
, you can access the API of the Form and the internal state within other componentsProvided HOC:
withField
, to encapsulating custom components as Field that conform the Semi Form data flow.HOC - withFormApi
You can encapsulate the component via
Note that the encapsulated components must be placed inside the Form structure.
withFormApi
HOC so that the formApi of the parent Form component can be called directly inside the componentNote that the encapsulated components must be placed inside the Form structure.
HOC - withFormState
You can encapsulate the component via
Note that the encapsulated components must be placed inside the Form structure.
withFormState
HOC so that the component has direct access to the Form State of the parent Form component.Note that the encapsulated components must be placed inside the Form structure.
Take over custom components
Via
withField
, you can extend other custom components into Field. Form will taking over its behavior.With Field did the following things.
- Take over the
value
of the component (or other properties specified by valueKey),onChange
(or other callback functions specified by onKeyChangeFnName) - Insert Field's
<Form.Label>
above the field - Insert Field's
<ErrorMessage>
under the field - Insert Field's extraText under the field
With Field Options specific configuration can be consulted withFieldOption
Your custom controlled component needs to do the following:
- When the value changes, call
props.onChange
and use the latest value as an input parameter - Respond to changes in
props.value
and update your component UI rendering results
API reference
Form Props
Properties | Instructions | Type | Default |
---|---|---|---|
autoScrollToError | If setting true,when submit or call formApi.validate () fails verification, it will automatically scroll to the wrong field, object config refer to options | boolean| object | false |
allowEmpty | Whether to keep the key of the null field in the values, keep the key when true, and remove the key when false | boolean | false |
component | For declaring fields, not used at the same time as render, props.children | ReactNode | |
className | Classname for form tag | string | |
disabled | If true, all fields inside the form structure will automatically inherit the disabled attribute | boolean | false |
extraTextPosition | The extraTextPosition property applied to each Field uniformly controls the display position of extraText. Middle (the vertical direction is displayed in the order of Label, extraText, and Field), bottom (the vertical direction is displayed in the order of Label, Field, and extraText) | string | 'bottom' |
getFormApi | This function will be executed once when the form is mounted and returns formApi. formApi can be used to modify the internal state of the form (value, touched, error) | function (formApi: object) | |
initValues | Used to uniformly set the initial value of the form (will be consumed only once when form is mount) | object | |
layout | The layout of fields, optional horizontal or vertical | string | 'vertical' |
labelCol | Uniformly applied to the label label layout of each Field, with Col Component, set span , span values, such as {span: 6, selected: 2} | object | |
labelAlign | Text-align value of label | string | 'left' |
labelPosition | Location of label in Field, optional 'top', 'left', 'inset' (inset label only partial component support) | string | 'top' |
labelWidth | Width of field'r label | string|number | |
onChange | Callback invoked when form update, including Fields mount/unmount / value change / blur / validation status change / error status change. | function (formState: object) | |
onErrorChange | Callback when the validation state of form updated. The first parameter: formState.errors, second parameter: name of the field that has changed and it's error message (available after v2.66) | function(values:object, changedError: object) | |
onValueChange | Callback invoked when form values update. The first parameter: formState.values, second parameter: name of the field and it's value | function (values: object, changedValue: object) | |
onReset | Callback invoked after clicked on reset button or executed formApi.reset() | function () | |
onSubmit | Callback invoked after clicked on submit button or executed formApi.submit() , and all validation pass. | function (values: object, e: event) | |
onSubmitFail | Callback invoked after clicked on submit button or executed formApi.submit() ,but validate failed. | function (error: object, values: object, e: event) | |
render | For declaring fields, not used at the same time as component, props.children | function | |
showValidateIcon | Whether the verification information block in the field automatically adds the corresponding status icon display | boolean | true |
style | inline style of form element | object | |
stopValidateWithError | Apply stopValidateWithError to each Field uniformly. For usage instructions, see the API of the same name in Field props (available after v2.42) | boolean | false |
stopPropagation | Whether to prevent submit or reset events from bubbling. This is used in nested Form scenarios to prevent events from propagating outwards when the inner Form submits or resets, triggering events in the outer Form. The default is { reset: false, submit: false } (available after v2.63) | object | |
trigger | Apply the trigger uniformly to each Field to control the timing of verification. For detailed instructions, see the API of the same name in Field props.(available after v2.42) | string|array | 'change' |
validateFields | Form-level custom validate functions are called at submit or formApi.validate(). Supported synchronous / asynchronous function | function (values) | |
wrapperCol | Uniformly apply the layout on each Field, with Col component, set span , span values, such as {span: 20, offset: 4} | object |
FormState
FormState stores all the state values within the Form, including the values of each field, error information, touched status
Name | Instructions | Initial value | Example |
---|---|---|---|
values | Value Collection of the form | {} | {fieldA: 'str', fieldB: true} |
errors | Form error information collection, you can decide whether to allow users to submit by judging whether there is error information | {} | {fieldA: 'length not valid'} |
touched | The collection of fields the user has clicked on | {} | {fieldA: true} |
How to access the form state
- By calling
formApi.getFormState()
- By declaring fields through child render function, formState will injected as a parameter
- By declaring fields through render props, formState will injected as a parameter
- Via useFormState hook
- Via withFormState HOC
FormApi
We provide FormApi. You have easy access to FormApi both inside and outside the Form, which allows you to use getter and setter to get and manipulate the values of FormState.
The table below describes the features available in the formApi.
The table below describes the features available in the formApi.
Function | Description | example |
---|---|---|
getFormProps | Get Form Component Props, support after v2.57.0 | formApi.getFormProps(propNames?: string[]) |
getFormState | Get FormState | formApi.getFormState() |
submitForm | Manually submit form operation | formApi.submitForm() |
reset | Reset the form manually | formApi.reset(fields?: Array <string>) |
validate | Manually trigger validation of the entire form. the verification of the entire Field will be triggered by default when no parameters are passed , if you want to trigger the verification of some fields, pass in the target field array After the Form level validator is configured, the Field level validator will not be triggered again when submit or formApi.validate() | formApi.validate() .then(values => {}) .catch(errors => {}) OR formApi.validate(['fieldA','fieldB']) |
setValues | Set the values of the entire form. The isOverride in the second parameter is false by default. By default, only the values of the existing field in the Form are updated from newValues toformState.values . When isOverride is true , the newValues will be overwritten and assigned to formState.values | formApi.setValues(newValues: object, {isOverride: boolean}) |
getValues | Get the values of all Field | formApi.getValues() |
setValue | provides direct modification of formState.values method. The difference from setValues is that it only modifies a single field. | formApi.setValue(field: string, newFieldValue: any) |
getValue | Get the value of all / single Field | formApi.getValue() formApi.getValue(field: string) |
setTouched | Modify formState.touched | formApi.setTouched(field: string, isTouched: boolean) |
getTouched | Get the touched state of the Field | formApi.getTouched(field: string) |
setError | Modify the error information of a field | formApi.setError(field: string, fieldErrorMessage: string) |
getError | Get Error Status of Field | formApi.getError(field: string) |
getFieldExist | Get whether the field exists in the Form | formApi.getFieldExist(field: string) |
scrollToField | Scroll to the specified field, the second input parameter will be passed to scroll-into-view-if-needed | formApi.scrollToField(field: string, scrollOpts: ScrollIntoViewOptions) |
scrollToError | Scroll to the field with validation error. You can pass a specified field or index. If you pass index, scroll to the index-th error DOM. If you do not pass any parameters, scroll to the first validation error position in the DOM tree. Available after v2.61.0 | formApi.scrollToError( ScrollToErrorOptions |
How to access formApi
- The Form component in the
ComponentDidMount
phase will execute thegetFormApi
callback passed in by props. You can save a reference to formApi in the callback function for subsequent calls (example code below) In addition, we provide other ways to get formApi, and you can choose different ways of calling according to your preference. - Use reference to get form instance,you can access form instance & its formApi
- By declaring fields through "child render function", formApi will injected as a parameter
- By declaring fields through "render props", formApi will injected as a parameter
- Via useFormApi hook for children component of Form
- Via withFormApi HOC for children component of Form
Field Props
Properties | Description | Type | Default | Examples |
---|---|---|---|---|
field | The mapping path of the field's value in formState.values. Form will use this value to distinguish the internal form control. Required!!! | string | ||
label | The label text for this field. When not passed, it defaults to the same name as field | string | ||
labelPosition | Label position of this field, optional 'top' / 'left' / 'inset' | string | ||
labelAlign | Text-align of the label text of this field | string | ||
labelWidth | The width of the label text of this field | string|number | ||
noLabel | When you don't need to add label automatically, you can set this value to true | boolean | ||
name | Field name. When passed in, the corresponding className will be automatically added to the field wrapper div, such as: money => '.semi-form-field-money'. After v2.24, the name will also be transparently transmitted to the underlying component for consumption. For example, you can configure the name attribute of input | string | ||
fieldClassName | The className of the entire fieldWrapper is the same as the name parameter, except that the prefix is not automatically appended | string | ||
fieldStyle | The inline style of the entire fieldWrapper since v1.9.0 | object | ||
initValue | The initial value of the field (consumed only once when Field mounted, subsequent updates are invalid), it has higher priority than the values in Form's initValues | any(type depends on current component) | ||
validate | The custom validation function for this form control. Supports synchronous and asynchronous verification. Rules does not take effect when validate is set | function(fieldValue, values) | (fieldValue) => fieldValue.length>5? 'error balabala': '' | |
rules | validation rules, validation library based on async-validator | array | const rules = [{type:' string ', message:' invalidate string'} ] | |
validateStatus | The validation result status of this form control, optional: success / error / warning / default | string | 'default' | |
trigger | The timing of triggering the verification, optional: blur / change / custom / mount 1. When set to custom, only formApi will trigger the verification 2.mount (triggered once when mounting) | string | 'change' | |
onChange | Callback invoked when this field value changes | |||
transform | transform field values before validation | function(fieldValue) | (value) => Number(value) | |
allowEmptyString | Whether to allow values to be empty strings. When the value is '' by default, the key corresponding to this field will be removed from values . If you want to keep the key, you need to set allowEmptyString to true | boolean | false | |
convert | After the field value changes, before rerender, update the value of filed | function(fieldValue) | (value) => newValue | |
stopValidateWithError | When it is true, the rules check is used. After encountering the first rule that fails the check, it will no longer trigger the check of subsequent rules since v0.35.0 | boolean | false | |
helpText | Custom prompt information, which is displayed in the same block as the verification information. When both have values, the verification information is displayed first since v1.0.0 | ReactNode | ||
extraText | Additional prompt information, you can use this when both error information and prompt copy are required, after helpText/errorMessage since v1.0.0 | ReactNode | ||
pure | Whether to only take over the data stream, when true, it will not automatically insert modules such as ErrorMessage, Label, extraText, etc. The style and DOM structure are consistent with the original components since v1.1.0 | boolean | false | |
extraTextPosition | controls the display position of extraText. Middle (the vertical direction is displayed in the order of Label, extraText, and Field), bottom (the vertical direction is displayed in the order of Label, Field, and extraText) since v1.9.0 | string | 'bottom' | |
...other | The other configurable properties of the component can be passed in together with the above properties, such as the size / placeholder of Input,Field passes it to the component itself |
Field Api
We also provide
fieldApi
, most of which is similar to formApi
, with the difference that fieldApi limits the scope of modification, and it can only modify the bound fieldFunction | Instructions | example |
---|---|---|
setValue | Modify the value of the current Field | fieldApi.setValue(newValue: any) |
getValue | Gets the value of the current Field | fieldApi.getValue() |
setTouched | Modify the value of the current Field | fieldApi.setTouched(true) |
getTouched | Get Field's status | fieldApi.getTouched() |
setError | Modify the error information of the current Field | fieldApi.setError(newErrorMessage: string) |
getError | Gets field's error status | fieldApi.getError() |
ArrayField Props
For dynamically added and deleted array form items, we provide the ArrayField scope to simplify add/remove operations
Properties | Description | Type | Default |
---|---|---|---|
field | The mapping path of the value of the form control in formState.values Required, for example, there is an ArrayField responsible for rendering a[0].name, a[1].name, a[2].name three lines, their The parent is a, here props.field should be a | string | |
initValue | The initial value of ArrayField, if the initial value is configured in both formProps.initValues and arrayFieldProps.initValue, the priority of the latter is higher | Array | [] |
children | The content of ArrayField, the type is Function, the function input parameters are operation functions such as add, addWithInitValue and arrayFields, and it should return ReactNode after execution | Function(ArrayFieldChildrenProps) => ReactNode |
Form.Section
Properties | Description | Type |
---|---|---|
text | Title of section | ReactNode |
className | Classname | string |
style | Inline style | object |
children | Content of section | ReactNode |
Form.Label
By default,
If you need to self-insert Label elsewhere, we have provided the
Label
is self-inserted into each Field
by Form
.If you need to self-insert Label elsewhere, we have provided the
Label
component for you.Properties | Description | Type | Default |
---|---|---|---|
text | Label content | ReactNode | |
required | Whether to show the required * | boolean | false |
extra | Content after required | ReactNode | |
align | Text-align | string | 'left' |
className | Classname of label wrapper | string | |
style | Inline style | string | |
width | Label width | number | |
optional | Whether to automatically append the "(optional)" text mark after the text (automatically switch the same semantic text according to different languages configured by Locale). When this item is true, the required * will no longer be displayed. | boolean | false |
Form.InputGroup
Properties | Description | Type | Default | Version |
---|---|---|---|---|
className | Classname of Form.InputGroup | string | ||
style | Inline style | object | ||
label | Label text of Form.InputGroup | Label | string | ||
labelPosition | Label position,optional: 'top'/'left'/'inset'. When Form and InputGroup are passed in at the same time, the InputGroup props shall prevail | string | 'top' | |
extraText | Additional prompt information, when the error message and prompt text need to appear at the same time, you can use this, located after errorMessage | ReactNode | v2.29.0 | |
extraTextPosition | Control the display position of extraText, optional middle (vertical direction is displayed in the order of Label, extraText, Group), bottom (vertical direction is displayed in the order of Label, Group, extraText) | string | 'bottom' | v2.29.0 |
When extraTextPositon is middle and labelPosition is left. Since extraText is allowed to be ReactNode, the height of the content is variable, and the Label will no longer ensure that it can be aligned with the first line of text in the Field / InputGroup.
Form.Slot
Properties | Instructions | Type | Default |
---|---|---|---|
label | Slot's Label configuration, for example {text: 'semi', align: 'left'}; can also be passed directly into string, inside the Slot will be automatically encapsulated in legal Label format | object|string | |
className | Classname of Slot Wrapper | string | |
style | Slot inline style | object | |
children | Content of slot. You can place your custom component here | ReactNode | |
error | ErrorMessage of Slot | ErrorMessage|ReactNode |
Form.ErrorMessage
- When the error is React Node, String, boolean, render directly
- When the error is an array, the join operation is automatically performed to aggregate the error information in the array
Properties | Instructions | Type | Default |
---|---|---|---|
error | Error message content | string|array|ReactNode|undefined|boolean | {} |
className | Classname of ErrorMessage wrapper | string | |
style | Inline style | object |
withFieldOption
key | Description | Default |
---|---|---|
valueKey | The component represents the property of the value, such as Switch, Radio is' checked 'and Input is' value ' | 'value' |
onKeyChangeFnName | The callback function when the component value changes, generally 'onChange' | 'onChange' |
valuePath | The path of the value attribute to the first parameter in the callback function, such as Radio's onChange (e.target. checked), then the value needs to be set to target .checked; Radio Group's onChange (e.target. value), which is' target .value '; if the first parameter is the value itself, there is no need to take the value down, the item does not need to be set | |
withCursor | Do you need to maintain a cursor for Input class components | false |
Accessibility
ARIA
- aria-labelledby、for
- Field component will automatically add label DOM. The for attribute of label is the same as
props.id
orprops.name
orprops.field
; theid
attribute of label is determined byprops.id
orprops.name
orprops.field
, and the value format is${props.field}-label
; - When the props.labelPosition of the Form or Field is set to
inset
, there is no label tag at this time, but a div tag. The div tag corresponding to insetLabel will be automatically appended withid
, the value is the same as the id of the above label, corresponding to thearia-labelledby
of the Field component - The Field component will be automatically appended with
aria-labelledby
, the value is the same as the id of the above label
- Field component will automatically add label DOM. The for attribute of label is the same as
- aria-required
- When the Field is configured with required fields (that is, props.rules contains require: true or props.label is configured with required: true), the Field component will be automatically appended with
aria-required = true
(except Form.Switch, Form.CheckboxGroup)
- When the Field is configured with required fields (that is, props.rules contains require: true or props.label is configured with required: true), the Field component will be automatically appended with
- aria-invalid 、aria-errormessage
- When the Field check fails, the Field component will be automatically added with the
aria-invalid
= true attribute, except for Form.CheckboxGroup. - When the Field check fails, the Field component will be automatically appended with the
aria-errormessage
attribute, the value of which is the id of the DOM element corresponding to the errorMessage (format like:${props.field}-errormessage
), except for Form.CheckboxGroup.
- When the Field check fails, the Field component will be automatically added with the
- aria-describedby
- When the Field is configured with
helpText
orextraText
, the Field component will be automatically added with thearia-describedby
attribute, whose value is the id of the DOM element corresponding to helpText and extraText (format like:${props.field}-helpText
,${props.field}-extraText
)
- When the Field is configured with
Content Guidelines
- Form title
- The title of the form needs to follow the writing specification of the title
- Form label
- The label is a short description of the input box. The label is not a help text, so it should not be a description of the input
- Labels must:
- Place it above or below the input box
- Short (1-3 words)
- Use case conventions for statements (first letter uppercase, others lowercase)
- Help text
- Help text use statement writing conventions, capitalized
- Form button
- For the content Guidelines of the form button, refer to Button component
Design Tokens
FAQ
- Why did I declare the form, modify the value, and the data is not automatically mapped to formState.values?
Check that the field has been passed correctly, and thefield
attribute on the Field component is a must-fill property ! - Why doesn't the passed
defaultValue
ordefaultChecked
take effect?
Refer to the beginning of the document Field. The Form.Field component unifies the default value. You should pass the default value usinginitValue
orinitValues
- Why did the component not change and the value not take effect after
initValue
andinitValues
were updated asynchronously?
initValue
,initValues
are only consumed once when Field and Form mount, and subsequent asynchronous updates will not take effect.
If your initial value needs to be taken remotely, you can update it usingformApi.setValue / setValues
after you get the value
Or send a newkey
directly to Form or Field to force it to remount. - Why can't getValues get a certain field?If the field has no initial value,
getValues
cannot get this item. You can setinitValues
/initValue
or set theallowEmpty
attribute to the form. - Why does hitting enter on the input box trigger the form's submit?This is standard HTML behavior. We do not plan to intervene and we will remain the same as the HTML. If there is really only one input element in the form, and you don't want to trigger the submit callback when you press Enter, it is recommended to use preventDefault for the enter of the keydown event of input to prevent the default behavior.Click #767 for background and content.
- The form will automatically save the historical input items, what should I do if I don't want this function?
Before v2.3, Form did not configurefor
,name
,id
and other attributes for input controls strictly according to the A11y accessibility standard, so this function was not available in previous versions. After v2.3, we implemented it strictly according to the W3C standard. If you don't want the browser to automatically save history input items, you can also turn it off by settingautoComplete=off
at the Form level or Field level