Skip to content

FilledInput API

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

Import

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

Component name

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

Props

NameTypeDefaultDescription
autoCompletestringThis prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it following the specification.
autoFocusboolfalseIf true, the input element is focused during the first mount.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'primary'
| 'secondary'
The color of the component. It supports those theme colors that make sense for this component. The prop defaults to the value ('primary') inherited from the parent FormControl component.
defaultValueanyThe default value. Use when the component is not controlled.
disabledboolfalseIf true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.
disableUnderlineboolfalseIf true, the input will not have an underline.
endAdornmentnodeEnd InputAdornment for this component.
errorboolfalseIf true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.
fullWidthboolfalseIf true, the input will take up the full width of its container.
idstringThe id of the input element.
inputComponentelementType'input'The component used for the input element. Either a string to use a HTML element or a component.
inputPropsobjectAttributes applied to the input element.
inputRefrefPass a ref to the input element.
margin'dense'
| 'none'
If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.
maxRowsnumber
| string
Maximum number of rows to display when multiline option is set to true.
minRowsnumber
| string
Minimum number of rows to display when multiline option is set to true.
multilineboolfalseIf true, a textarea element is rendered.
namestringName attribute of the input element.
onChangefuncCallback fired when the value is changed.

Signature:
function(event: object) => void
event: The event source of the callback. You can pull out the new value by accessing event.target.value (string).
placeholderstringThe short hint displayed in the input before the user enters a value.
readOnlyboolfalseIt prevents the user from changing the value of the field (not from interacting with the field).
requiredboolfalseIf true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.
rowsnumber
| string
Number of rows to display when multiline option is set to true.
startAdornmentnodeStart InputAdornment for this component.
typestring'text'Type of the input element. It should be a valid HTML5 input type.
valueanyThe value of the input element, required for a controlled component.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (InputBase).

Inheritance

While not explicitly documented above, the props of the InputBase component are also available on FilledInput. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiFilledInput-rootStyles applied to the root element.
colorSecondary.MuiFilledInput-colorSecondaryStyles applied to the root element if color secondary.
underline.MuiFilledInput-underlineStyles applied to the root element unless disableUnderline={true}.
focused.Mui-focusedPseudo-class applied to the root element if the component is focused.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
adornedStart.MuiFilledInput-adornedStartStyles applied to the root element if startAdornment is provided.
adornedEnd.MuiFilledInput-adornedEndStyles applied to the root element if endAdornment is provided.
error.Mui-errorPseudo-class applied to the root element if error={true}.
sizeSmall.MuiFilledInput-sizeSmallStyles applied to the input element if size="small".
multiline.MuiFilledInput-multilineStyles applied to the root element if multiline={true}.
hiddenLabel.MuiFilledInput-hiddenLabelStyles applied to the root element if hiddenLabel={true}.
input.MuiFilledInput-inputStyles applied to the input element.
inputSizeSmall.MuiFilledInput-inputSizeSmallStyles applied to the input element if size="small".
inputHiddenLabel.MuiFilledInput-inputHiddenLabelStyles applied to the `input` if in .
inputMultiline.MuiFilledInput-inputMultilineStyles applied to the input element if multiline={true}.
inputAdornedStart.MuiFilledInput-inputAdornedStartStyles applied to the input element if startAdornment is provided.
inputAdornedEnd.MuiFilledInput-inputAdornedEndStyles applied to the input element if endAdornment is provided.

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