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

Import

import FormControl from '@mui/joy/FormControl';
// or
import { FormControl } from '@mui/joy';

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'
| '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.

slotProps{ root?: func
| object }
{}

The props used for each slot inside.

slots{ root?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

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.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescription
root.MuiFormControl-root'div'The component that renders the root.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledClass name applied to the root element if disabled={true}.
.Mui-errorState class applied to the root element if error={true}.
.MuiFormControl-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiFormControl-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiFormControl-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiFormControl-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiFormControl-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiFormControl-horizontalhorizontalClass name applied to the root element if orientation="horizontal".
.MuiFormControl-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiFormControl-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiFormControl-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiFormControl-verticalverticalClass name applied to the root element if orientation="vertical".

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.