Skip to content
Edit this page

OutlinedInput API

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

import OutlinedInput from '@material-ui/core/OutlinedInput';

Props

Name Type Default Description
autoComplete string This property 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.
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 union: func |
 object
 This property can be used to pass a ref callback to the input element.
labelWidth number 0 The width of the label.
margin enum: '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.
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 union: string |
 number
 Number of rows to display when multiline option is set to true.
rowsMax union: 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 properties supplied will be provided to the root element (InputBase).

CSS

You can override all the class names injected by Material-UI thanks to the classes property. This property accepts the following keys:

Name Description
root Styles applied to the root element.
focused Styles applied to the root element if the component is focused.
disabled Styles applied to the root element if disabled={true}.
adornedStart Styles applied to the root element if startAdornment is provided.
adornedEnd Styles applied to the root element if endAdornment is provided.
error Styles applied to the root element if error={true}.
marginDense Styles applied to the input element if margin="dense".
multiline Styles applied to the root element if multiline={true}.
notchedOutline Styles applied to the NotchedOutline element.
input Styles applied to the input element.
inputMarginDense Styles applied to the input element if margin="dense".
inputSelect Styles applied to the input element if select={true}.
inputMultiline Styles applied to the input element if multiline={true}.
inputAdornedStart Styles applied to the input element if startAdornment is provided.
inputAdornedEnd Styles applied to the input element if endAdornment is provided.

Have a look at the overriding styles with classes section and the implementation of the component for more detail.

If using the overrides key of the theme, you need to use the following style sheet name: MuiOutlinedInput.

Inheritance

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

Notes

The component is fully StrictMode compatible.

Demos