InputAdornment API
API reference docs for the React InputAdornment component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
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 of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
position* | 'end' | 'start' | - | The position this adornment should appear relative to the |
children | node | - | The content of the component, normally an |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
component | elementType | - | The component used for the root node. Either a string to use a HTML element or a component. |
disablePointerEvents | bool | false | Disable pointer events on the root. This allows for the content of the adornment to focus the |
disableTypography | bool | false | If children is a string then disable wrapping in a Typography 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. |
variant | 'filled' | 'outlined' | 'standard' | - | The variant to use. Note: If you are using 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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.MuiInputAdornment-disablePointerEvents | disablePointerEvents | Styles applied to the root element if disablePointerEvents={true} . |
.MuiInputAdornment-filled | filled | Styles applied to the root element if variant="filled" . |
.MuiInputAdornment-outlined | outlined | Styles applied to the root element if variant="outlined" . |
.MuiInputAdornment-positionEnd | positionEnd | Styles applied to the root element if position="end" . |
.MuiInputAdornment-positionStart | positionStart | Styles applied to the root element if position="start" . |
.MuiInputAdornment-root | root | Styles applied to the root element. |
.MuiInputAdornment-sizeSmall | sizeSmall | Styles applied if the adornment is used inside |
.MuiInputAdornment-standard | standard | Styles applied to the root element if variant="standard" . |
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
styleOverrides
property in a custom theme.
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.