OutlinedInput API

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

Importação

import OutlinedInput from '@mui/material/OutlinedInput';
// ou
import { OutlinedInput } 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 MuiOutlinedInput can be used when providing default props or style overrides in the theme.

Propriedades

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

Nome	Tipo	Padrão	Descrição
autoComplete	string		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.
autoFocus	bool	false	If `true`, the `input` element is focused during the first mount.
classes	object		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.
defaultValue	any		The default input value. Use when the component is not controlled.
disabled	bool	false	If `true`, the `input` element is disabled. The prop defaults to the value (`false`) inherited from the parent FormControl component.
endAdornment	node		End `InputAdornment` for this component.
error	bool	false	If `true`, the `input` will indicate an error. The prop defaults to the value (`false`) inherited from the parent FormControl component.
fullWidth	bool	false	If `true`, the `input` will take up the full width of its container.
id	string		The id of the `input` element.
inputComponent	elementType	'input'	The component used for the `input` element. Either a string to use a HTML element or a component.
inputProps	object	{}	Attributes applied to the `input` element.
inputRef	ref		Pass a ref to the `input` element.
label	node		The label of the `input`. It is only used for layout. The actual labelling is handled by `InputLabel`.
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.
maxRows	number \| string		Maximum number of rows to display when multiline option is set to true.
minRows	number \| string		Minimum number of rows to display when multiline option is set to true.
multiline	bool	false	If `true`, a TextareaAutosize element is rendered.
name	string		Name attribute of the `input` element.
notched	bool	false	If `true`, the outline is notched to accommodate the label.
onChange	func		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).
placeholder	string		The short hint displayed in the `input` before the user enters a value.
readOnly	bool	false	It prevents the user from changing the value of the field (not from interacting with the field).
required	bool	false	If `true`, the `input` element is required. The prop defaults to the value (`false`) inherited from the parent FormControl component.
rows	number \| string		Number of rows to display when multiline option is set to true.
slots	{ input?: elementType, root?: elementType }	{}
startAdornment	node		Start `InputAdornment` for this component.
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.
type	string	'text'	Type of the `input` element. It should be a valid HTML5 input type.
value	any		The value of the `input` element, required for a controlled component.

O ref é encaminhado para o elemento raiz.

Herança

While not explicitly documented above, the props of the InputBase component are also available on OutlinedInput. You can take advantage of this to target nested components.

CSS

Nome da regra	Classe global	Descrição
root	.MuiOutlinedInput-root	Estilos aplicados ao elemento raiz.
colorSecondary	.MuiOutlinedInput-colorSecondary	Estilos aplicados para o elemento raiz se the color is secondary.
focused	.Mui-focused	Estilos aplicados para o elemento raiz se the component is focused.
disabled	.Mui-disabled	Estilos aplicados para o elemento raiz se `disabled={true}`.
adornedStart	.MuiOutlinedInput-adornedStart	Estilos aplicados para o elemento raiz se `startAdornment` is provided.
adornedEnd	.MuiOutlinedInput-adornedEnd	Estilos aplicados para o elemento raiz se `endAdornment` is provided.
error	.Mui-error	Pseudo-class aplicada a o elemento raiz se `error={true}`.
sizeSmall	.MuiOutlinedInput-sizeSmall	Estilos aplicados para the input element se `size="small"`.
multiline	.MuiOutlinedInput-multiline	Estilos aplicados para o elemento raiz se `multiline={true}`.
notchedOutline	.MuiOutlinedInput-notchedOutline	Estilos aplicados a the NotchedOutline element.
input	.MuiOutlinedInput-input	Estilos aplicados a the input element.
inputSizeSmall	.MuiOutlinedInput-inputSizeSmall	Estilos aplicados para the input element se `size="small"`.
inputMultiline	.MuiOutlinedInput-inputMultiline	Estilos aplicados para the input element se `multiline={true}`.
inputAdornedStart	.MuiOutlinedInput-inputAdornedStart	Estilos aplicados para the input element se `startAdornment` is provided.
inputAdornedEnd	.MuiOutlinedInput-inputAdornedEnd	Estilos aplicados para the input element se `endAdornment` is provided.

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.

Demonstrações

Text Field