Pular para o conteúdo

InputAdornment API

API documentation for the React InputAdornment component. Learn about the available props, and the CSS API.

Import

import InputAdornment from '@material-ui/core/InputAdornment';
// or
import { InputAdornment } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiInputAdornment can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeThe content of the component, normally an IconButton or string.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
disablePointerEventsboolfalseDisable pointer events on the root. This allows for the content of the adornment to focus the input on click.
disableTypographyboolfalseIf 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 nameGlobal classDescription
root.MuiInputAdornment-rootStyles applied to the root element.
filled.MuiInputAdornment-filledStyles applied to the root element if variant="filled".
positionStart.MuiInputAdornment-positionStartStyles applied to the root element if position="start".
positionEnd.MuiInputAdornment-positionEndStyles applied to the root element if position="end".
disablePointerEvents.MuiInputAdornment-disablePointerEventsStyles applied to the root element if disablePointerEvents=true.
hiddenLabel.MuiInputAdornment-hiddenLabelStyles applied if the adornment is used inside .
sizeSmall.MuiInputAdornment-sizeSmall

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos