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.

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

children

The content of the component.

Type:node

color

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.

Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

disabled

If true, the children are in disabled state.

Type:bool

Default:false

error

If true, the children will indicate an error.

Type:bool

Default:false

orientation

The content direction flow.

Type:'horizontal'
| 'vertical'

Default:'vertical'

required

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.

Type:bool

Default:false

size

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

Type:'sm'
| 'md'
| 'lg'
| string

Default:'md'

slotProps

The props used for each slot inside.

Type:{ root?: func
| object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

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.

root

The component that renders the root.

Global class: .MuiFormControl-root

Default: 'div'

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.Mui-disabledSTATE

Class name applied to the root element if disabled={true}.

.Mui-errorSTATE

State class applied to the root element if error={true}.

.MuiFormControl-colorDanger

Class name applied to the root element if color="danger".

.MuiFormControl-colorNeutral

Class name applied to the root element if color="neutral".

.MuiFormControl-colorPrimary

Class name applied to the root element if color="primary".

.MuiFormControl-colorSuccess

Class name applied to the root element if color="success".

.MuiFormControl-colorWarning

Class name applied to the root element if color="warning".

.MuiFormControl-horizontal

Class name applied to the root element if orientation="horizontal".

.MuiFormControl-sizeLg

Class name applied to the root element if size="lg".

.MuiFormControl-sizeMd

Class name applied to the root element if size="md".

.MuiFormControl-sizeSm

Class name applied to the root element if size="sm".

.MuiFormControl-vertical

Class name applied to the root element if orientation="vertical".