InputLabel API
The API documentation of the InputLabel React component. Learn more about the properties and the CSS customization points.
import InputLabel from '@material-ui/core/InputLabel';Props
| Name | Type | Default | Description |
|---|---|---|---|
| children | node | The contents of the InputLabel. |
|
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| disableAnimation | bool | false | If true, the transition animation is disabled. |
| disabled | bool | If true, apply disabled class. |
|
| error | bool | If true, the label will be displayed in an error state. |
|
| focused | bool | If true, the input of this label is focused. |
|
| margin | enum: 'dense' |
If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. |
|
| required | bool | if true, the label will indicate that the input is required. |
|
| shrink | bool | If true, the label is shrunk. |
|
| variant | enum: 'standard' | 'outlined' | 'filled' |
The variant to use. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (FormLabel).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| focused | Styles applied to the root element if focused={true}. |
| disabled | Styles applied to the root element if disabled={true}. |
| error | Styles applied to the root element if error={true}. |
| required | Styles applied to the root element if required={true}. |
| asterisk | Styles applied to the asterisk element. |
| formControl | Styles applied to the root element if the component is a descendant of FormControl. |
| marginDense | Styles applied to the root element if margin="dense". |
| shrink | Styles applied to the input element if shrink={true}. |
| animated | Styles applied to the input element if disableAnimation={false}. |
| filled | Styles applied to the root element if variant="filled". |
| outlined | Styles applied to the root element if variant="outlined". |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiInputLabel.
Inheritance
The properties of the FormLabel component are also available. You can take advantage of this behavior to target nested components.
Notes
The component is fully StrictMode compatible.