Pular para o conteúdo

Input API

Documentação da API para o componente React Input . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import Input from '@mui/material/Input';
// ou
import { Input } from '@mui/material';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Nome do componente

The name MuiInput can be used when providing default props or style overrides in the theme.

Propriedades

Propriedades do componente InputBase também estão disponíveis.

NomeTipoPadrãoDescrição
autoCompletestring
This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.
autoFocusboolfalse
If true, the input element is focused during the first mount.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
color'primary'
| 'secondary'
| string
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.
components{ Input?: elementType, Root?: elementType }{}
The components used for each slot inside the InputBase. Either a string to use a HTML element or a component.
componentsProps{ input?: object, root?: object }{}
The props used for each slot inside the Input.
defaultValueany
The default input value. Use when the component is not controlled.
disabledboolfalse
If true, the input element is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.
disableUnderlineboolfalse
If true, the input will not have an underline.
endAdornmentnode
End InputAdornment for this component.
errorboolfalse
If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.
fullWidthboolfalse
If true, the input will take up the full width of its container.
idstring
The id of the input element.
inputComponentelementType'input'
The component used for the input element. Either a string to use a HTML element or a component.
inputPropsobject{}
Attributes applied to the input element.
inputRefref
Pass a ref to the input element.
margin'dense'
| 'none'
If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.
maxRowsnumber
| string
Maximum number of rows to display when multiline option is set to true.
minRowsnumber
| string
Minimum number of rows to display when multiline option is set to true.
multilineboolfalse
If true, a TextareaAutosize element is rendered.
namestring
Name attribute of the input element.
onChangefunc
Callback fired when the value is changed.

Signature:
function(event: object) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
placeholderstring
The short hint displayed in the input before the user enters a value.
readOnlyboolfalse
It prevents the user from changing the value of the field (not from interacting with the field).
requiredboolfalse
If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.
rowsnumber
| string
Number of rows to display when multiline option is set to true.
startAdornmentnode
Start InputAdornment for this component.
sxArray<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.
typestring'text'
Type of the input element. It should be a valid HTML5 input type.
valueany
The value of the input element, required for a controlled component.

O ref é encaminhado para o elemento raiz.

Herança

Embora não explicitamente documentado acima, as propriedades do componente InputBase também estão disponíveis em Input. Você pode tirar vantagem disso para manipular componentes aninhados.

CSS

Nome da regraClasse globalDescrição
root.MuiInput-rootEstilos aplicados ao elemento raiz.
formControl.MuiInput-formControlEstilos aplicados para o elemento raiz se the component is a descendant of FormControl.
focused.Mui-focusedEstilos aplicados para o elemento raiz se the component is focused.
disabled.Mui-disabledEstilos aplicados para o elemento raiz se disabled={true}.
colorSecondary.MuiInput-colorSecondaryEstilos aplicados para o elemento raiz se color secondary.
underline.MuiInput-underlineEstilos aplicados em o elemento raiz a menos que disableUnderline={true}.
error.Mui-errorPseudo-class aplicada a o elemento raiz se error={true}.
sizeSmall.MuiInput-sizeSmallEstilos aplicados para the input element se size="small".
multiline.MuiInput-multilineEstilos aplicados para o elemento raiz se multiline={true}.
fullWidth.MuiInput-fullWidthEstilos aplicados para o elemento raiz se fullWidth={true}.
input.MuiInput-inputEstilos aplicados a the input element.
inputSizeSmall.MuiInput-inputSizeSmallEstilos aplicados para the input element se size="small".
inputMultiline.MuiInput-inputMultilineEstilos aplicados para the input element se multiline={true}.
inputTypeSearch.MuiInput-inputTypeSearchEstilos aplicados para the input element se type="search".

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Demonstrações