Skip to content

FormControl API

API reference docs for the React FormControl component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import FormControl from '@mui/joy/FormControl';
// or
import { FormControl } from '@mui/joy';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
color'danger'
| 'info'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalse
If true, the children are in disabled state.
errorboolfalse
If true, the children will indicate an error.
orientation'horizontal'
| 'vertical'
'vertical'
The content direction flow.
requiredboolfalse
If true, the user must specify a value for the input before the owning form can be submitted. If true, the asterisk appears on the FormLabel.
size'sm'
| 'md'
| 'lg'
| string
'md'
The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

Theme default props

You can use JoyFormControl to change the default props of this component with the theme.