FormControlUnstyled API

API documentation for the React FormControlUnstyled component. Learn about the available props and the CSS API.

Import

import FormControlUnstyled from '@mui/base/FormControlUnstyled';
// or
import { FormControlUnstyled } from '@mui/base';

You can learn about the difference by reading this guide on minimizing bundle size.

Provides context such as filled/focused/error/required for form inputs. Relying on the context provides high flexibility and ensures that the state always stays consistent across the children of the FormControl. This context is used by the following components:

FormLabel
FormHelperText
Input
InputLabel

You can find one composition example below and more going to the demos.

<FormControl>
  <InputLabel htmlFor="my-input">Email address</InputLabel>
  <Input id="my-input" aria-describedby="my-helper-text" />
  <FormHelperText id="my-helper-text">We'll never share your email.</FormHelperText>
</FormControl>

⚠️ Only one Input can be used within a FormControl because it create visual inconsistencies. For instance, only one input can be focused at the same time, the state shouldn't be shared.

Props

Props of the native component are also available.

Name	Type	Default	Description
children	node \| func		The content of the component.
className	string		Class name applied to the root element.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
components	{ Root?: elementType }	{}	The components used for each slot inside the FormControl. Either a string to use a HTML element or a component.
disabled	bool	false	If `true`, the label, input and helper text should be displayed in a disabled state.
error	bool	false	If `true`, the label is displayed in an error state.
required	bool	false	If `true`, the label will indicate that the `input` is required.

The ref is forwarded to the root element.

Demos

Form control