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
Form Control
Form Control provides context such as `isInvalid`, `isDisabled`, and `isRequired` to form elements
Props#
isDisabled
isDisabledDescription
Type
booleanDefault
falseisInvalid
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
booleanDefault
falseisReadOnly
isReadOnlyDescription
If true, the form control will be readonly
Type
booleanDefault
falseisRequired
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
booleanDefault
falselabel
labelDescription
The label text used to inform users as to what information is requested for a text field.
Type
stringProps#
isDisabled
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
booleanDefault
falseisInvalid
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
booleanDefault
falseisReadOnly
isReadOnlyDescription
If true, the form control will be readonly
Type
booleanDefault
falseisRequired
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
booleanDefault
falselabel
labelDescription
The label text used to inform users as to what information is requested for a text field.
Type
string