Skip to content

InputBase API

API reference docs for the React InputBase component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

Import

import InputBase from '@mui/material/InputBase';
// or
import { InputBase } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

InputBase contains as few styles as possible. It aims to be a simple building block for creating an input. It contains a load of style reset and some state logic.

Props

Props of the native 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'
| 'error'
| 'info'
| 'success'
| 'warning'
| 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:{}

componentsProps

The extra props for the slot components. You can override the existing props or add new ones.
This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.

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

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

disableInjectingGlobalStyles

If true, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once.

Type:bool

Default:false

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:element type

Default:'input'

inputProps

Attributes applied to the input element.

Type:object

Default:{}

inputRef

Pass a ref to the input element.

Type:ref

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

onBlur

Callback fired when the input is blurred.
Notice that the first argument (event) might be undefined.

Type:func

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).
onInvalid

Callback fired when the input doesn't satisfy its constraints.

Type:func

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

size

The size of the component.

Type:'medium'
| 'small'
| string

slotProps

The extra props for the slot components. You can override the existing props or add new ones.
This prop is an alias for the componentsProps prop, which will be deprecated in the future.

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

Default:{}

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.

Theme default props

You can use MuiInputBase 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.

.Mui-readOnlySTATE

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

.MuiInputBase-adornedEnd

Styles applied to the root element if endAdornment is provided.

Rule name:adornedEnd

.MuiInputBase-adornedStart

Styles applied to the root element if startAdornment is provided.

Rule name:adornedStart

.MuiInputBase-colorSecondary

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

Rule name:colorSecondary

.MuiInputBase-formControl

Styles applied to the root element if the component is a descendant of FormControl.

Rule name:formControl

.MuiInputBase-fullWidth

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

Rule name:fullWidth

.MuiInputBase-hiddenLabel

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

Rule name:hiddenLabel

.MuiInputBase-input

Styles applied to the input element.

Rule name:input

.MuiInputBase-inputAdornedEnd

Styles applied to the input element if endAdornment is provided.

Rule name:inputAdornedEnd

.MuiInputBase-inputAdornedStart

Styles applied to the input element if startAdornment is provided.

Rule name:inputAdornedStart

.MuiInputBase-inputHiddenLabel

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

Rule name:inputHiddenLabel

.MuiInputBase-inputMultiline

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

Rule name:inputMultiline

.MuiInputBase-inputSizeSmall

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

Rule name:inputSizeSmall

.MuiInputBase-inputTypeSearch

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

Rule name:inputTypeSearch

.MuiInputBase-multiline

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

Rule name:multiline

.MuiInputBase-root

Styles applied to the root element.

Rule name:root

.MuiInputBase-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: