InputLabel API

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

Import

import InputLabel from '@material-ui/core/InputLabel';
// 或
import { InputLabel } from '@material-ui/core';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

属性

名称	类型	默认值	描述
children	node		The content of the component.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
color	'primary' \| 'secondary'		The color of the component. It supports those theme colors that make sense for this component.
disableAnimation	bool	false	If `true`, the transition animation is disabled.
disabled	bool	false	如果被设置为 `true`，那么该组件将会被禁用。
error	bool	false	If `true`, the label should be displayed in an error state.
focused	bool	false	If `true`, the `input` of this label is focused.
margin	'dense'		If `dense`, will adjust vertical spacing. This is normally obtained via context from FormControl.
required	bool	false	if `true`, the label will indicate that the `input` is required.
shrink	bool	false	If `true`, the label is shrunk.
variant	'filled' \| 'outlined' \| 'standard'		The variant to use.

ref 则会被传递到根元素中。
Any other props supplied will be provided to the root element (FormLabel).

Inheritance

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

CSS

Rule name	Global class	描述
root	.MuiInputLabel-root	Styles applied to the root element.
focused	.Mui-focused	Pseudo-class applied to the root element if `focused={true}`.
disabled	.Mui-disabled	Pseudo-class applied to the root element if `disabled={true}`.
error	.Mui-error	Pseudo-class applied to the root element if `error={true}`.
required	.Mui-required	Pseudo-class applied to the root element if `required={true}`.
asterisk	.MuiInputLabel-asterisk	Pseudo-class applied to the asterisk element.
formControl	.MuiInputLabel-formControl	Styles applied to the root element if the component is a descendant of `FormControl`.
sizeSmall	.MuiInputLabel-sizeSmall	Styles applied to the root element if `size="small"`.
shrink	.MuiInputLabel-shrink	Styles applied to the input element if `shrink={true}`.
animated	.MuiInputLabel-animated	Styles applied to the input element unless `disableAnimation={true}`.
filled	.MuiInputLabel-filled	Styles applied to the root element if `variant="filled"`.
outlined	.MuiInputLabel-outlined	Styles applied to the root element if `variant="outlined"`.

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

With a rule name of the classes object prop.
With a global class name.
With a theme and an styleOverrides property.

If that isn't sufficient, you can check the implementation of the component for more detail.

Demos

Text Fields