OutlinedInput API

API documentation for the React OutlinedInput component. Learn about the available props, and the CSS API.

Import

import OutlinedInput from '@material-ui/core/OutlinedInput';
// or
import { OutlinedInput } from '@material-ui/core';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

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	false	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'		The color of the component. It supports those theme colors that make sense for this component. The prop defaults to the value (`'primary'`) inherited from the parent FormControl component.
defaultValue	any		The default value. Use when the component is not controlled.
disabled	bool	false	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	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`. If specified `labelWidth` is ignored.
labelWidth	number	0	The width of the label. Is ignored if `label` is provided. Prefer `label` if the `input` label appears with a strike through.
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 `textarea` 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.
startAdornment	node		Start `InputAdornment` for this component.
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.
Any other props supplied will be provided to the root element (InputBase).

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.

CSS

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

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

With a rule name of the classes object prop.
With a global class name.
With a theme and an styleOverrides property.

If that isn't sufficient, you can check the implementation of the component for more detail.

Demos

Text Fields