0 Tk

filled-input

Import

import FilledInput from '@mui/material/FilledInput';
// or
import { FilledInput } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props of the InputBase component are also available.

Props

Name Type Default Description
autoComplete string - This 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.
autoFocus bool - If true, the input element is focused during the first mount.
classes object - Override or extend the styles applied to the component. See CSS classes API below for more details.
color ‘primary’ | ‘secondary’ | string - The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.
components { Input?: elementType, Root?: elementType } {} The components used for each slot inside.
componentsProps { input?: object, root?: object } {} The extra props for the slot components. You can override the existing props or add new ones.
defaultValue any - The default value. Use when the component is not controlled.
disabled bool - If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.
disableUnderline bool false If true, the input will not have an underline.
endAdornment node - End InputAdornment for this component.
error bool - If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.
fullWidth bool false If true, the input will take up the full width of its container.
hiddenLabel bool false If true, the label is hidden. This is used to increase density for a FilledInput. Be sure to add aria-label to the input element.
id string - The id of the input element.
inputComponent elementType ‘input’ The component used for the input element. Either a string to use a HTML element or a component.
inputProps object {} Attributes applied to the input element.
inputRef ref - Pass 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.
maxRows number | string - Maximum number of rows to display when multiline option is set to true.
minRows number | string - Minimum number of rows to display when multiline option is set to true.
multiline bool false If true, a TextareaAutosize element is rendered.
name string - Name attribute of the input element.
onChange func - Callback fired when the value is changed. Signature: function(event: React.ChangeEvent) => void
placeholder string - The short hint displayed in the input before the user enters a value.
readOnly bool - It prevents the user from changing the value of the field (not from interacting with the field).
required bool - If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.
rows number | string - Number of rows to display when multiline option is set to true.
slotProps { input?: object, root?: object } {} The extra props for the slot components. You can override the existing props or add new ones. This prop is an alias for the componentsProps prop, which will be deprecated in the future.
slots { input?: elementType, root?: elementType } {} The components used for each slot inside. This prop is an alias for the components prop, which will be deprecated in the future.
startAdornment node - Start InputAdornment for this component.
sx Array<func | object | bool> | func | object - The system prop that allows defining system overrides as well as additional CSS styles. See the sx page for more details.
type string ‘text’ Type of the input element. It should be a valid HTML5 input type.
value any - The value of the input element, required for a controlled component.

The ref is forwarded to the root element.

Inheritance

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

Theme default props

You can use MuiFilledInput to change the default props of this component with the theme.

CSS Classes

These class names are useful for styling with CSS. They are applied to the component’s slots when specific states are triggered.

Class name Rule name Description
.Mui-disabled State class applied to the root element if disabled={true}.
.Mui-error State class applied to the root element if error={true}.
.Mui-focused State class applied to the root element if the component is focused.
.MuiFilledInput-adornedEnd adornedEnd Styles applied to the root element if endAdornment is provided.
.MuiFilledInput-adornedStart adornedStart Styles applied to the root element if startAdornment is provided.
.MuiFilledInput-colorSecondary colorSecondary Styles applied to the root element if color secondary.
.MuiFilledInput-hiddenLabel hiddenLabel Styles applied to the root element if hiddenLabel={true}.
.MuiFilledInput-input input Styles applied to the input element.
.MuiFilledInput-multiline multiline Styles applied to the root element if multiline={true}.
.MuiFilledInput-root root Styles applied to the root element.
.MuiFilledInput-sizeSmall sizeSmall Styles applied to the root element if size="small".
.MuiFilledInput-underline underline Styles applied to the root element unless disableUnderline={true}.

You can override the style of the component using one of these customization options:

Source Code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.