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.

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.

NameTypeDefaultDescription
autoCompletestring-

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.

autoFocusbool-

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

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

color'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
-

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.

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

The components used for each slot inside.

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

The extra props for the slot components. You can override the existing props or add new ones.

defaultValueany-

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

disabledbool-

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

disableInjectingGlobalStylesboolfalse

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.

endAdornmentnode-

End InputAdornment for this component.

errorbool-

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

fullWidthboolfalse

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

idstring-

The id of the input element.

inputComponentelement type'input'

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

inputPropsobject{}

Attributes applied to the input element.

inputRefref-

Pass a ref to the input element.

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.

maxRowsnumber
| string
-

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

minRowsnumber
| string
-

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

multilineboolfalse

If true, a TextareaAutosize element is rendered.

namestring-

Name attribute of the input element.

onBlurfunc-

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

onChangefunc-

Callback fired when the value is changed.

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

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

placeholderstring-

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

readOnlybool-

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

requiredbool-

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

rowsnumber
| string
-

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

size'medium'
| 'small'
| string
-

The size of the component.

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

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.

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

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

startAdornmentnode-

Start InputAdornment for this component.

sxArray<func
| object
| bool>
| func
| object
-

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

See the `sx` page for more details.

typestring'text'

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

valueany-

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

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.

Class nameRule nameDescription
.Mui-disabledStyles applied to the root element if disabled={true}.
.Mui-errorState class applied to the root element if error={true}.
.Mui-focusedStyles applied to the root element if the component is focused.
.Mui-readOnlyState class applied to the root element if readOnly={true}.
.MuiInputBase-adornedEndadornedEndStyles applied to the root element if endAdornment is provided.
.MuiInputBase-adornedStartadornedStartStyles applied to the root element if startAdornment is provided.
.MuiInputBase-colorSecondarycolorSecondaryStyles applied to the root element if the color is secondary.
.MuiInputBase-formControlformControlStyles applied to the root element if the component is a descendant of FormControl.
.MuiInputBase-fullWidthfullWidthStyles applied to the root element if fullWidth={true}.
.MuiInputBase-hiddenLabelhiddenLabelStyles applied to the root element if hiddenLabel={true}.
.MuiInputBase-inputinputStyles applied to the input element.
.MuiInputBase-inputAdornedEndinputAdornedEndStyles applied to the input element if endAdornment is provided.
.MuiInputBase-inputAdornedStartinputAdornedStartStyles applied to the input element if startAdornment is provided.
.MuiInputBase-inputHiddenLabelinputHiddenLabelStyles applied to the input element if hiddenLabel={true}.
.MuiInputBase-inputMultilineinputMultilineStyles applied to the input element if multiline={true}.
.MuiInputBase-inputSizeSmallinputSizeSmallStyles applied to the input element if size="small".
.MuiInputBase-inputTypeSearchinputTypeSearchStyles applied to the input element if type="search".
.MuiInputBase-multilinemultilineStyles applied to the root element if multiline={true}.
.MuiInputBase-rootrootStyles applied to the root element.
.MuiInputBase-sizeSmallsizeSmallStyles applied to the input element if size="small".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.