InputBase API
API documentation for the React InputBase component. Learn about the available props and the CSS API.
Import
import InputBase from '@mui/material/InputBase';
// or
import { InputBase } from '@mui/material';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.
Component name
The nameMuiInputBase can be used when providing default props or style overrides in the theme.Props
Props of the native 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' | '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. 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. |
| disableInjectingGlobalStyles | bool | false | 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. |
| 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 | element type | 'input' | The component used for the input element. Either a string to use a HTML element or a component.⚠️ Needs to be able to hold a ref. |
| 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. | |
| onBlur | func | Callback fired when the input is blurred.Notice that the first argument (event) might be undefined. | |
| 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). | |
| onInvalid | func | Callback fired when the input doesn't satisfy its constraints. | |
| 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. | |
| 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. |
| 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.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiInputBase-root | Styles applied to the root element. |
| formControl | .MuiInputBase-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}. |
| adornedStart | .MuiInputBase-adornedStart | Styles applied to the root element if startAdornment is provided. |
| adornedEnd | .MuiInputBase-adornedEnd | Styles applied to the root element if endAdornment is provided. |
| error | .Mui-error | State class applied to the root element if error={true}. |
| sizeSmall | .MuiInputBase-sizeSmall | Styles applied to the input element if size="small". |
| multiline | .MuiInputBase-multiline | Styles applied to the root element if multiline={true}. |
| colorSecondary | .MuiInputBase-colorSecondary | Styles applied to the root element if the color is secondary. |
| fullWidth | .MuiInputBase-fullWidth | Styles applied to the root element if fullWidth={true}. |
| hiddenLabel | .MuiInputBase-hiddenLabel | Styles applied to the root element if hiddenLabel={true}. |
| readOnly | .MuiInputBase-readOnly | State class applied to the root element if readOnly={true}. |
| input | .MuiInputBase-input | Styles applied to the input element. |
| inputSizeSmall | .MuiInputBase-inputSizeSmall | Styles applied to the input element if size="small". |
| inputMultiline | .MuiInputBase-inputMultiline | Styles applied to the input element if multiline={true}. |
| inputTypeSearch | .MuiInputBase-inputTypeSearch | Styles applied to the input element if type="search". |
| inputAdornedStart | .MuiInputBase-inputAdornedStart | Styles applied to the input element if startAdornment is provided. |
| inputAdornedEnd | .MuiInputBase-inputAdornedEnd | Styles applied to the input element if endAdornment is provided. |
| inputHiddenLabel | .MuiInputBase-inputHiddenLabel | Styles applied to the input element if hiddenLabel={true}. |
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.