跳转到内容

OutlinedInput API

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

Import

import OutlinedInput from '@mui/material/OutlinedInput';
// 或
import { OutlinedInput } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

属性

Props of the InputBase component are also available.

名称类型默认值描述
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'
| string
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.
components{ Input?: elementType, Root?: elementType }{}
defaultValueany
The default input value. Use when the component is not controlled.
disabledboolfalse
If true, the input element is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.
endAdornmentnode
End InputAdornment for this component.
errorboolfalse
If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.
fullWidthboolfalse
If true, the input will take up the full width of its container.
idstring
The 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.
inputPropsobject{}
Attributes applied to the input element.
inputRefref
Pass a ref to the input element.
labelnode
The label of the input. It is only used for layout. The actual labelling is handled by InputLabel.
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.
multilineboolfalse
If true, a textarea element is rendered.
namestring
Name attribute of the input element.
notchedboolfalse
If true, the outline is notched to accommodate the label.
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.
readOnlyboolfalse
It prevents the user from changing the value of the field (not from interacting with the field).
requiredboolfalse
If 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.
startAdornmentnode
Start InputAdornment for this component.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
typestring'text'
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.

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

Inheritance

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

CSS

Rule nameGlobal class描述
root.MuiOutlinedInput-rootStyles applied to the root element.
colorSecondary.MuiOutlinedInput-colorSecondaryStyles applied to the root element if the color is secondary.
focused.Mui-focusedStyles applied to the root element if the component is focused.
disabled.Mui-disabledStyles applied to the root element if disabled={true}.
adornedStart.MuiOutlinedInput-adornedStartStyles applied to the root element if startAdornment is provided.
adornedEnd.MuiOutlinedInput-adornedEndStyles applied to the root element if endAdornment is provided.
error.Mui-errorPseudo-class applied to the root element if error={true}.
sizeSmall.MuiOutlinedInput-sizeSmallStyles applied to the input element if size="small".
multiline.MuiOutlinedInput-multilineStyles applied to the root element if multiline={true}.
notchedOutline.MuiOutlinedInput-notchedOutlineStyles applied to the NotchedOutline element.
input.MuiOutlinedInput-inputStyles applied to the input element.
inputSizeSmall.MuiOutlinedInput-inputSizeSmallStyles applied to the input element if size="small".
inputMultiline.MuiOutlinedInput-inputMultilineStyles applied to the input element if multiline={true}.
inputAdornedStart.MuiOutlinedInput-inputAdornedStartStyles applied to the input element if startAdornment is provided.
inputAdornedEnd.MuiOutlinedInput-inputAdornedEndStyles applied to the input element if endAdornment is provided.

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

Demos