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:

Text Field

Import

import OutlinedInput from '@mui/material/OutlinedInput';
// or
import { OutlinedInput } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the InputBase component are also available.

Name	Type	Default	Description
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		If `true`, the `input` element is focused during the first mount.
classes	object		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.
defaultValue	any		The default value. Use when the component is not controlled.
disabled	bool		If `true`, the component is disabled. The prop defaults to the value (`false`) inherited from the parent FormControl component.
endAdornment	node		End `InputAdornment` for this component.
error	bool		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		If `true`, the outline is notched to accommodate the label.
onChange	func		Callback fired when the value is changed. Signature:`function(event: React.ChangeEvent) => 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		It prevents the user from changing the value of the field (not from interacting with the field).
required	bool		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 }	{}	The components used for each slot inside. This prop is an alias for the `components` prop, which will be deprecated in the future.
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.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the InputBase component are also available in 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.

Global class	Rule name	Description
.MuiOutlinedInput-root	root	Styles applied to the root element.
.MuiOutlinedInput-colorSecondary	colorSecondary	Styles applied to the root element if the color is secondary.
.Mui-focused	focused	Styles applied to the root element if the component is focused.
.Mui-disabled	disabled	Styles applied to the root element if `disabled={true}`.
.MuiOutlinedInput-adornedStart	adornedStart	Styles applied to the root element if `startAdornment` is provided.
.MuiOutlinedInput-adornedEnd	adornedEnd	Styles applied to the root element if `endAdornment` is provided.
.Mui-error	error	State class applied to the root element if `error={true}`.
.MuiOutlinedInput-sizeSmall	sizeSmall	Styles applied to the input element if `size="small"`.
.MuiOutlinedInput-multiline	multiline	Styles applied to the root element if `multiline={true}`.
.MuiOutlinedInput-notchedOutline	notchedOutline	Styles applied to the NotchedOutline element.
.MuiOutlinedInput-input	input	Styles applied to the input element.
.MuiOutlinedInput-inputSizeSmall	inputSizeSmall	Styles applied to the input element if `size="small"`.
.MuiOutlinedInput-inputMultiline	inputMultiline	Styles applied to the input element if `multiline={true}`.
.MuiOutlinedInput-inputAdornedStart	inputAdornedStart	Styles applied to the input element if `startAdornment` is provided.
.MuiOutlinedInput-inputAdornedEnd	inputAdornedEnd	Styles applied to the input element if `endAdornment` is provided.
.MuiOutlinedInput-inputTypeSearch	inputTypeSearch	Styles applied to the input element if `type="search"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.