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.

Component demos

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.

autoComplete

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.

Type:string

autoFocus

If true, the input element is focused during the first mount.

Type:bool

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

color

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.

Type:'primary'
| 'secondary'
| string

components

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.

Type:{ Input?: elementType, Root?: elementType }

Default:{}

defaultValue

The default value. Use when the component is not controlled.

Type:any

disabled

If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:bool

endAdornment

End InputAdornment for this component.

Type:node

error

If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:bool

fullWidth

If true, the input will take up the full width of its container.

Type:bool

Default:false

id

The id of the input element.

Type:string

inputComponent

The component used for the input element. Either a string to use a HTML element or a component.

Type:elementType

Default:'input'

inputProps

Attributes applied to the input element.

Type:object

Default:{}

inputRef

Pass a ref to the input element.

Type:ref

label

The label of the input. It is only used for layout. The actual labelling is handled by InputLabel.

Type:node

margin

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.

Type:'dense'
| 'none'

maxRows

Maximum number of rows to display when multiline option is set to true.

Type:number
| string

minRows

Minimum number of rows to display when multiline option is set to true.

Type:number
| string

multiline

If true, a TextareaAutosize element is rendered.

Type:bool

Default:false

name

Name attribute of the input element.

Type:string

notched

If true, the outline is notched to accommodate the label.

Type:bool

onChange

Callback fired when the value is changed.

Type:func

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

The short hint displayed in the input before the user enters a value.

Type:string

readOnly

It prevents the user from changing the value of the field (not from interacting with the field).

Type:bool

required

If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.

Type:bool

rows

Number of rows to display when multiline option is set to true.

Type:number
| string

slots

The components used for each slot inside.
This prop is an alias for the components prop, which will be deprecated in the future.

Type:{ input?: elementType, root?: elementType }

Default:{}

startAdornment

Start InputAdornment for this component.

Type:node

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

type

Type of the input element. It should be a valid HTML5 input type.

Type:string

Default:'text'

value

The value of the input element, required for a controlled component.

Type:any

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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.Mui-disabledSTATE

Styles applied to the root element if disabled={true}.

.Mui-errorSTATE

State class applied to the root element if error={true}.

.Mui-focusedSTATE

Styles applied to the root element if the component is focused.

.MuiOutlinedInput-adornedEnd

Styles applied to the root element if endAdornment is provided.

Rule name:adornedEnd

.MuiOutlinedInput-adornedStart

Styles applied to the root element if startAdornment is provided.

Rule name:adornedStart

.MuiOutlinedInput-colorSecondary

Styles applied to the root element if the color is secondary.

Rule name:colorSecondary

.MuiOutlinedInput-input

Styles applied to the input element.

Rule name:input

.MuiOutlinedInput-inputAdornedEnd

Styles applied to the input element if endAdornment is provided.

Rule name:inputAdornedEnd

.MuiOutlinedInput-inputAdornedStart

Styles applied to the input element if startAdornment is provided.

Rule name:inputAdornedStart

.MuiOutlinedInput-inputMultiline

Styles applied to the input element if multiline={true}.

Rule name:inputMultiline

.MuiOutlinedInput-inputSizeSmall

Styles applied to the input element if size="small".

Rule name:inputSizeSmall

.MuiOutlinedInput-inputTypeSearch

Styles applied to the input element if type="search".

Rule name:inputTypeSearch

.MuiOutlinedInput-multiline

Styles applied to the root element if multiline={true}.

Rule name:multiline

.MuiOutlinedInput-notchedOutline

Styles applied to the NotchedOutline element.

Rule name:notchedOutline

.MuiOutlinedInput-root

Styles applied to the root element.

Rule name:root

.MuiOutlinedInput-sizeSmall

Styles applied to the input element if size="small".

Rule name:sizeSmall


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