Color Schemes for FormControl are not implemented in the default theme. You can extend the theme to implement them.
Form Control
Form Control provides context such as `isInvalid`, `isDisabled`, and `isRequired` to form elements
Props#
colorScheme
colorSchemeDescription
Type
stringisDisabled
isDisabledDescription
If true, the form control will be disabled. This has 2 side effects:
- The FormLabel will have `data-disabled` attribute
- The form element (e.g, Input) will be disabled
Type
booleanisInvalid
isInvalidDescription
If true, the form control will be invalid. This has 2 side effects:
- The FormLabel and FormErrorIcon will have `data-invalid` set to true
- The form element (e.g, Input) will have `aria-invalid` set to true
Type
booleanisReadOnly
isReadOnlyDescription
If true, the form control will be readonly
Type
booleanisRequired
isRequiredDescription
If true, the form control will be required. This has 2 side effects:
- The FormLabel will show a required indicator
- The form element (e.g, Input) will have `aria-required` set to true
Type
booleanlabel
labelDescription
The label text used to inform users as to what information is requested for a text field.
Type
stringsize
sizeDescription
Sizes for FormControl are not implemented in the default theme. You can extend the theme to implement them.
Type
stringvariant
variantDescription
Variants for FormControl are not implemented in the default theme. You can extend the theme to implement them.
Type
stringProps#
colorScheme
colorSchemeDescription
Color Schemes for FormControl are not implemented in the default theme. You can extend the theme to implement them.
Type
stringisDisabled
isDisabledDescription
If true, the form control will be disabled. This has 2 side effects:
- The FormLabel will have `data-disabled` attribute
- The form element (e.g, Input) will be disabled
Type
booleanisInvalid
isInvalidDescription
If true, the form control will be invalid. This has 2 side effects:
- The FormLabel and FormErrorIcon will have `data-invalid` set to true
- The form element (e.g, Input) will have `aria-invalid` set to true
Type
booleanisReadOnly
isReadOnlyDescription
If true, the form control will be readonly
Type
booleanisRequired
isRequiredDescription
If true, the form control will be required. This has 2 side effects:
- The FormLabel will show a required indicator
- The form element (e.g, Input) will have `aria-required` set to true
Type
booleanlabel
labelDescription
The label text used to inform users as to what information is requested for a text field.
Type
stringsize
sizeDescription
Sizes for FormControl are not implemented in the default theme. You can extend the theme to implement them.
Type
stringvariant
variantDescription
Variants for FormControl are not implemented in the default theme. You can extend the theme to implement them.
Type
string