InputAdornment API
The API documentation of the InputAdornment React component. Learn more about the properties and the CSS customization points.
import InputAdornment from '@material-ui/core/InputAdornment';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 | enum: 'start' | 'end' |
The position this adornment should appear relative to the Input. |
|
| variant | enum: '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 properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| filled | Styles applied to the root element if variant="filled". |
| positionStart | Styles applied to the root element if position="start". |
| positionEnd | Styles applied to the root element if position="end". |
| disablePointerEvents | Styles applied to the root element if disablePointerEvents=true. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiInputAdornment.
Notes
The component is fully StrictMode compatible.