跳转到内容

TextField API

想要学习更多组件属性和 CSS API,可以查阅 React TextField 组件的 API 文档。

导入

import TextField from '@mui/material/TextField';
// 或
import { TextField } from '@mui/material';
您可以通过 阅读本指南以最小化捆包大小 来了解这种差异。

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

组件名称

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

属性

FormControl 组件的属性也是可用的。

名称类型默认值描述
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 API below for more details.
color'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'primary'
The color of the component. It supports those theme colors that make sense for this component.
defaultValueany
The default value. Use when the component is not controlled.
disabledboolfalse
如果被设置为 true,那么该组件将会被禁用。
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.
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.
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.

ref 则会被传递到根元素中。

继承

尽管上文没有明确记载, <1>FormControl 组件 的 props 也在 TextField上可用。 您可以将此用于 <3>目标嵌套组件

CSS

规则名称全局类名描述
root.MuiTextField-rootStyles applied to the root element.

您可以使用组件自定义选项对组件进行个性化:

演示项目