InputAdornment API
The API documentation of the InputAdornment React component. Learn more about the props and the CSS customization points.
Import
import InputAdornment from '@material-ui/core/InputAdornment';
// or
import { InputAdornment } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Props
| Name | Type | Default | Description |
|---|---|---|---|
| children * | node | The content of the component, normally an IconButton or string. |
|
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| component | elementType | 'div' | The component used for the root node. Either a string to use a DOM element or a component. |
| disablePointerEvents | bool | false | Disable pointer events on the root. This allows for the content of the adornment to focus the input on click. |
| disableTypography | bool | false | If children is a string then disable wrapping in a Typography component. |
| position | 'start' | 'end' |
The position this adornment should appear relative to the Input. |
|
| variant | 'standard' | 'outlined' | 'filled' |
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.
Any other props supplied will be provided to the root element (native element).
CSS
- Style sheet name:
MuiInputAdornment. - Style sheet details:
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiInputAdornment-root | Styles applied to the root element. |
| filled | .MuiInputAdornment-filled | Styles applied to the root element if variant="filled". |
| positionStart | .MuiInputAdornment-positionStart | Styles applied to the root element if position="start". |
| positionEnd | .MuiInputAdornment-positionEnd | Styles applied to the root element if position="end". |
| disablePointerEvents | .MuiInputAdornment-disablePointerEvents | Styles applied to the root element if disablePointerEvents=true. |
| hiddenLabel | .MuiInputAdornment-hiddenLabel | Styles applied if the adornment is used inside <FormControl hiddenLabel />. |
| marginDense | .MuiInputAdornment-marginDense | Styles applied if the adornment is used inside <FormControl margin="dense" />. |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
overridesproperty.
If that's not sufficient, you can check the implementation of the component for more detail.