Skip to content

TextField API

API reference docs for the React TextField component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

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

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



The TextField is a convenience wrapper for the most common cases (80%). It cannot be all things to all people, otherwise the API would grow out of control.

Advanced Configuration

It's important to understand that the text field is a simple abstraction on top of the following components:

If you wish to alter the props applied to the input element, you can do so as follows:

const inputProps = {
  step: 300,
};

return <TextField id="time" type="time" inputProps={inputProps} />;

For advanced cases, please look at the source of TextField by clicking on the "Edit this page" button above. Consider either:

  • using the upper case props for passing values directly to the components
  • using the underlying components directly as shown in the demos

Props

Props of the FormControl component are also available.

NameTypeDefaultDescription
autoCompletestring-

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.

autoFocusboolfalse

If true, the input element is focused during the first mount.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

color'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string		'primary'

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

defaultValueany-

The default value. Use when the component is not controlled.

disabledboolfalse

If true, the component is disabled.

errorboolfalse

If true, the label is displayed in an error state.

FormHelperTextPropsobject-

Props applied to the FormHelperText element.

fullWidthboolfalse

If true, the input will take up the full width of its container.

helperTextnode-

The helper text content.

idstring-

The id of the input element. Use this prop to make label and helperText accessible for screen readers.

InputLabelPropsobject-

Props applied to the InputLabel element. Pointer events like onClick are enabled if and only if shrink is true.

inputPropsobject-

Attributes applied to the input element.

InputPropsobject-

Props applied to the Input element. It will be a FilledInput, OutlinedInput or Input component depending on the variant prop value.

inputRefref-

Pass a ref to the input element.

labelnode-

The label content.

margin'dense'
| 'none'
| 'normal'		'none'

If dense or normal, will adjust vertical spacing of this and contained components.

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.

multilineboolfalse

If true, a textarea element is rendered instead of an input.

namestring-

Name attribute of the input element.

onChangefunc-

Callback 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).
placeholderstring-

The short hint displayed in the input before the user enters a value.

requiredboolfalse

If true, the label is displayed as required and the input element is required.

rowsnumber
| string		-

Number of rows to display when multiline option is set to true.

selectboolfalse

Render a Select element while passing the Input element to Select as input parameter. If this option is set you must pass the options of the select as children.

SelectPropsobject-

Props applied to the Select element.

size'medium'
| 'small'
| string		-

The size of the component.

slotProps{ formHelperText?: func
| object, htmlInput?: func
| object, input?: func
| object, inputLabel?: func
| object, select?: func
| object }		{}

The props used for each slot inside.

slots{ formHelperText?: elementType, htmlInput?: elementType, input?: elementType, inputLabel?: elementType, select?: elementType }{}

The components used for each slot inside.

sxArray<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.

typestring-

Type of the input element. It should be a valid HTML5 input type.

valueany-

The value of the input element, required for a controlled component.

variant'filled'
| 'outlined'
| 'standard'		'outlined'

The variant to use.

The component cannot hold a ref.

Inheritance

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

Theme default props

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

Slots

Slot nameClass nameDefault componentDescription
inputOutlinedInputThe component that renders the input.
inputLabelInputLabelThe component that renders the input's label.
htmlInput'input'The html input element.
formHelperTextFormHelperTextThe component that renders the helper text.
selectSelectThe component that renders the select.

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 nameRule nameDescription
.MuiTextField-rootrootStyles applied to the root element.

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