Input API
API documentation for the React Input component. Learn about the available props and the CSS API.
Import
import Input from '@mui/material/Input';
// or
import { Input } from '@mui/material';Component name
The nameMuiInput can be used when providing default props or style overrides in the theme.Props
Props of the InputBase component are also available.
| 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 | false | If true, the input element is focused during the first mount. |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| color | 'primary' | 'secondary' | 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. This prop is an alias for the slots prop. It's recommended to use the slots prop instead. |
| componentsProps | { 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 slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future. |
| defaultValue | any | The default value. Use when the component is not controlled. | |
| disabled | bool | false | If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component. |
| disableUnderline | bool | false | If true, the input will not have an underline. |
| endAdornment | node | End InputAdornment for this component. | |
| error | bool | false | If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component. |
| 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 input element. Either a string to use a HTML element or a component. |
| inputProps | object | {} | Attributes applied to the input element. |
| inputRef | ref | 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. | |
| maxRows | number | string | Maximum number of rows to display when multiline option is set to true. | |
| minRows | number | string | Minimum number of rows to display when multiline option is set to true. | |
| multiline | bool | false | If true, a TextareaAutosize element is rendered. |
| name | string | Name attribute of the input element. | |
| onChange | func | Callback fired when the value is changed. Signature: function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => voidevent: 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 | false | It prevents the user from changing the value of the field (not from interacting with the field). |
| required | bool | false | If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component. |
| rows | number | string | Number of rows to display when multiline option is set to true. | |
| 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. |
| startAdornment | node | Start InputAdornment for this component. | |
| sx | Array<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. | |
| 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.Inheritance
While not explicitly documented above, the props of the InputBase component are also available on Input. You can take advantage of this to target nested components.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiInput-root | Styles applied to the root element. |
| formControl | .MuiInput-formControl | Styles applied to the root element if the component is a descendant of FormControl. |
| 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}. |
| colorSecondary | .MuiInput-colorSecondary | Styles applied to the root element if color secondary. |
| underline | .MuiInput-underline | Styles applied to the root element unless disableUnderline={true}. |
| error | .Mui-error | State class applied to the root element if error={true}. |
| sizeSmall | .MuiInput-sizeSmall | Styles applied to the input element if size="small". |
| multiline | .MuiInput-multiline | Styles applied to the root element if multiline={true}. |
| fullWidth | .MuiInput-fullWidth | Styles applied to the root element if fullWidth={true}. |
| input | .MuiInput-input | Styles applied to the input element. |
| inputSizeSmall | .MuiInput-inputSizeSmall | Styles applied to the input element if size="small". |
| inputMultiline | .MuiInput-inputMultiline | Styles applied to the input element if multiline={true}. |
| inputTypeSearch | .MuiInput-inputTypeSearch | Styles applied to the input element if type="search". |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.