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.
Component name
The MuiInputAdornment
name can be used for providing default props or style overrides at the theme level.
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 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 input on click. |
disableTypography | bool | false | If children is a string then disable wrapping in a Typography component. |
position | 'end' | 'start' |
The position this adornment should appear relative to the Input . |
|
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.
Any other props supplied will be provided to the root element (native element).
CSS
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
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.