FormHelperText API
Documentação da API para o componente React FormHelperText . Aprenda sobre as propriedades disponíveis e a API CSS.
Importação
import FormHelperText from '@mui/material/FormHelperText';
// ou
import { FormHelperText } from '@mui/material';
Nome do componente
The nameMuiFormHelperText
can be used when providing default props or style overrides in the theme.Propriedades
Props of the nativo component are also available.
Nome | Tipo | Padrão | Descrição |
---|---|---|---|
children | node | The content of the component. If ' ' is provided, the component reserves one line height for displaying a future message. | |
classes | object | Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes. | |
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 helper text should be displayed in a disabled state. |
error | bool | false | If true , helper text should be displayed in an error state. |
filled | bool | false | If true , the helper text should use filled classes key. |
focused | bool | false | If true , the helper text should use focused classes key. |
margin | 'dense' | If dense , will adjust vertical spacing. This is normally obtained via context from FormControl. | |
required | bool | false | If true , the helper text should use required classes key. |
sx | 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' | A variante a usar. |
O
ref
é encaminhado para o elemento raiz.CSS
Nome da regra | Classe global | Descrição |
---|---|---|
root | .MuiFormHelperText-root | Estilos aplicados ao elemento raiz. |
error | .Mui-error | Pseudo-class aplicada a o elemento raiz se error={true} . |
disabled | .Mui-disabled | Pseudo-class aplicada a o elemento raiz se disabled={true} . |
sizeSmall | .MuiFormHelperText-sizeSmall | Estilos aplicados para o elemento raiz se size="small" . |
contained | .MuiFormHelperText-contained | Estilos aplicados para o elemento raiz se variant="filled" or variant="outlined" . |
focused | .Mui-focused | Pseudo-class aplicada a o elemento raiz se focused={true} . |
filled | .MuiFormHelperText-filled | Pseudo-class aplicada a o elemento raiz se filled={true} . |
required | .Mui-required | Pseudo-class aplicada a o elemento raiz se required={true} . |
Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.