FormControl API
Documentação da API para o componente React FormControl . Aprenda sobre as propriedades disponíveis e a API CSS.
Importação
import FormControl from '@mui/material/FormControl';
// ou
import { FormControl } from '@mui/material';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 InputBase 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.
Nome do componente
The nameMuiFormControl can be used when providing default props or style overrides in the theme.Propriedades
Propriedades do componente nativo também estão disponíveis.
| Nome | Tipo | Padrão | Descrição |
|---|---|---|---|
| children | node | O conteúdo do componente. | |
| classes | object | Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes. | |
| color | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
| component | elementType | The component used for the root node. 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 should be displayed in an error state. |
| focused | bool | false | If true, the component is displayed in focused state. |
| fullWidth | bool | false | If true, the component will take up the full width of its container. |
| hiddenLabel | bool | false | If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element. |
| margin | 'dense' | 'none' | 'normal' | 'none' | If dense or normal, will adjust vertical spacing of this and contained components. |
| required | bool | false | If true, the label will indicate that the input is required. |
| size | 'medium' | 'small' | string | 'medium' | The size of the autocomplete. |
| sx | Array<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. | |
| variant | 'filled' | 'outlined' | 'standard' | 'outlined' | A variante a usar. |
O
ref é encaminhado para o elemento raiz.CSS
| Nome da regra | Classe global | Descrição |
|---|---|---|
| root | .MuiFormControl-root | Estilos aplicados ao elemento raiz. |
| marginNormal | .MuiFormControl-marginNormal | Estilos aplicados para o elemento raiz se margin="normal". |
| marginDense | .MuiFormControl-marginDense | Estilos aplicados para o elemento raiz se margin="dense". |
| fullWidth | .MuiFormControl-fullWidth | Estilos aplicados para o elemento raiz se fullWidth={true}. |
Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:
- Com um nome de classe global.
- Com um nome de regra como parte da propriedade
styleOverridesdo componente em um tema personalizado.