跳转到内容

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';
// 或
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 of the 原生(Native) component are also available.

名称类型默认值描述
childrennode
The content of the component.
classNamestring
Class name applied to the root element.
componentelementType
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.
disabledboolfalse
If true, the label, input and helper text should be displayed in a disabled state.
errorboolfalse
If true, the label is displayed in an error state.
focusedboolfalse
If true, the component is displayed in focused state.
requiredboolfalse
If true, the label will indicate that the input is required.

ref 则会被传递到根元素中。

Demos