[go: up one dir, main page]

Skip to content

InputAdornment API

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

DemosImport
import InputAdornment from '@mui/material/InputAdornment';
// or
import { InputAdornment } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
position*'end'
| 'start'
-

The position this adornment should appear relative to the Input.

childrennode-

The content of the component, normally an IconButton or string.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType-

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

disablePointerEventsboolfalse

Disable pointer events on the root. This allows for the content of the adornment to focus the input on click.

disableTypographyboolfalse

If children is a string then disable wrapping in a Typography 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.

variant'filled'
| 'outlined'
| 'standard'
-

The variant to use. Note: If you are using the TextField component or the FormControl component you do not have to set this manually.

The ref is forwarded to the root element.
Theme default props

You can use MuiInputAdornment 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
.MuiInputAdornment-disablePointerEventsdisablePointerEventsStyles applied to the root element if disablePointerEvents={true}.
.MuiInputAdornment-filledfilledStyles applied to the root element if variant="filled".
.MuiInputAdornment-hiddenLabelhiddenLabelStyles applied if the adornment is used inside .
.MuiInputAdornment-outlinedoutlinedStyles applied to the root element if variant="outlined".
.MuiInputAdornment-positionEndpositionEndStyles applied to the root element if position="end".
.MuiInputAdornment-positionStartpositionStartStyles applied to the root element if position="start".
.MuiInputAdornment-rootrootStyles applied to the root element.
.MuiInputAdornment-sizeSmallsizeSmallStyles applied if the adornment is used inside .
.MuiInputAdornment-standardstandardStyles applied to the root element if variant="standard".

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.