Skip to content

OutlinedInput API

API reference docs for the React OutlinedInput component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import OutlinedInput from '@mui/material/OutlinedInput';
// or
import { OutlinedInput } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the InputBase component are also available.

NameTypeDefaultDescription
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.
autoFocusbool
If true, the input element is focused during the first mount.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
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.
This prop is an alias for the slots prop. It's recommended to use the slots prop instead.
defaultValueany
The default value. Use when the component is not controlled.
disabledbool
If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.
endAdornmentnode
End InputAdornment for this component.
errorbool
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.
labelnode
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.
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.
notchedbool
If true, the outline is notched to accommodate the label.
onChangefunc
Callback fired when the value is changed.

Signature:
function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => 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.
readOnlybool
It prevents the user from changing the value of the field (not from interacting with the field).
requiredbool
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.
slots{ input?: elementType, root?: elementType }{}
The components used for each slot inside.
This prop is an alias for the components prop, which will be deprecated in the future.
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.

The ref is forwarded to the root element.

Inheritance

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.

Theme default props

You can use MuiOutlinedInput to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Rule nameGlobal classDescription
root.MuiOutlinedInput-rootStyles applied to the root element.
colorSecondary.MuiOutlinedInput-colorSecondaryStyles applied to the root element if the color is secondary.
focused
STATE
.Mui-focusedStyles applied to the root element if the component is focused.
disabled
STATE
.Mui-disabledStyles applied to the root element if disabled={true}.
adornedStart.MuiOutlinedInput-adornedStartStyles applied to the root element if startAdornment is provided.
adornedEnd.MuiOutlinedInput-adornedEndStyles applied to the root element if endAdornment is provided.
error
STATE
.Mui-errorState class applied to the root element if error={true}.
sizeSmall.MuiOutlinedInput-sizeSmallStyles applied to the input element if size="small".
multiline.MuiOutlinedInput-multilineStyles applied to the root element if multiline={true}.
notchedOutline.MuiOutlinedInput-notchedOutlineStyles applied to the NotchedOutline element.
input.MuiOutlinedInput-inputStyles applied to the input element.
inputSizeSmall.MuiOutlinedInput-inputSizeSmallStyles applied to the input element if size="small".
inputMultiline.MuiOutlinedInput-inputMultilineStyles applied to the input element if multiline={true}.
inputAdornedStart.MuiOutlinedInput-inputAdornedStartStyles applied to the input element if startAdornment is provided.
inputAdornedEnd.MuiOutlinedInput-inputAdornedEndStyles applied to the input element if endAdornment is provided.
inputTypeSearch.MuiOutlinedInput-inputTypeSearchStyles applied to the input element if type="search".

You can override the style of the component using one of these customization options: