OutlinedInput API

The API documentation of the OutlinedInput React component. Learn more about the props and the CSS customization points.

Import

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

You can learn more about the difference by reading this guide.

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		If `true`, the `input` element will be focused during the first mount.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
className	string		The CSS class name of the wrapper element.
color	'primary' \| 'secondary'		The color of the component. It supports those theme colors that make sense for this component.
defaultValue	any		The default `input` element value. Use when the component is not controlled.
disabled	bool		If `true`, the `input` element will be disabled.
endAdornment	node		End `InputAdornment` for this component.
error	bool		If `true`, the input will indicate an error. This is normally obtained via context from FormControl.
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 native input. Either a string to use a DOM 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.
multiline	bool	false	If `true`, a textarea element will be 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: 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		It prevents the user from changing the value of the field (not from interacting with the field).
required	bool		If `true`, the `input` element will be required.
rows	string \| number		Number of rows to display when multiline option is set to true.
rowsMax	string \| number		Maximum 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).

CSS

Style sheet name: MuiOutlinedInput.
Style sheet details:

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	Styles applied to the root element if `error={true}`.
marginDense	.MuiOutlinedInput-marginDense	Styles applied to the `input` element if `margin="dense"`.
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.
inputMarginDense	.MuiOutlinedInput-inputMarginDense	Styles applied to the `input` element if `margin="dense"`.
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 thanks to one of these customization points:

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

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

Inheritance

The props of the InputBase component are also available. You can take advantage of this behavior to target nested components.

Demos

Text Fields