Input API
导入
import Input from '@mui/material/Input';
// 或
import { Input } from '@mui/material';
组件名称
在主题中,名称“MuiInput
”可用于提供默认属性(props),或者样式覆盖属性
InputBase 组件的属性也是可用的。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
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 | false | If true , the input element is focused during the first mount. |
classes | object | 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 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 the InputBase. Either a string to use a HTML element or a component. |
componentsProps | { input?: object, root?: object } | {} | The props used for each slot inside the Input. |
defaultValue | any | The default input value. Use when the component is not controlled. | |
disabled | bool | false | If true , the input element 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 | false | 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. |
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: object) => void event: The event source of the callback. You can pull out the new value by accessing event.target.value (string). | |
placeholder | string | The short hint displayed in the input before the user enters a value. | |
readOnly | bool | false | It prevents the user from changing the value of the field (not from interacting with the field). |
required | bool | false | 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 } | {} | |
slots | { input?: elementType, root?: elementType } | {} | |
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. |
ref
则会被传递到根元素中。继承
尽管上文没有明文记录, InputBase 组件 的属性(props) 在组件Input上同样是可用的。 你可以利用这一点来 指向嵌套组件CSS
规则名称 | 全局类名 | 描述 |
---|---|---|
root | .MuiInput-root | Styles applied to the root element. |
formControl | .MuiInput-formControl | Styles applied to the root element if the component is a descendant of FormControl . |
focused | .Mui-focused | Styles applied to the root element if the component is focused. |
disabled | .Mui-disabled | Styles applied to the root element if disabled={true} . |
colorSecondary | .MuiInput-colorSecondary | Styles applied to the root element if color secondary. |
underline | .MuiInput-underline | Styles applied to the root element unless disableUnderline={true} . |
error | .Mui-error | Pseudo-class applied to the root element if error={true} . |
sizeSmall | .MuiInput-sizeSmall | Styles applied to the input element if size="small" . |
multiline | .MuiInput-multiline | Styles applied to the root element if multiline={true} . |
fullWidth | .MuiInput-fullWidth | Styles applied to the root element if fullWidth={true} . |
input | .MuiInput-input | Styles applied to the input element. |
inputSizeSmall | .MuiInput-inputSizeSmall | Styles applied to the input element if size="small" . |
inputMultiline | .MuiInput-inputMultiline | Styles applied to the input element if multiline={true} . |
inputTypeSearch | .MuiInput-inputTypeSearch | Styles applied to the input element if type="search" . |
您可以使用组件自定义选项对组件进行个性化:
- 具备 全局类名.
- 在自定义主体中,设定一个规则名称作为组件的
styleOverrides
属性的一部分。