InputLabel API
The API documentation of the InputLabel React component. Learn more about the props and the CSS customization points.
Import
import InputLabel from '@material-ui/core/InputLabel';
// or
import { InputLabel } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Component name
The MuiInputLabel
name can be used for providing default props or style overrides at the theme level.
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. | |
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 | 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 | '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 | 'filled' | 'outlined' | 'standard' |
The variant to use. |
The ref
is forwarded to the root element.
Any other props supplied will be provided to the root element (FormLabel).
CSS
Rule name | Global class | Description |
---|---|---|
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 . |
marginDense | .MuiInputLabel-marginDense | Styles applied to the root element if margin="dense" . |
shrink | .MuiInputLabel-shrink | Styles applied to the input element if shrink={true} . |
animated | .MuiInputLabel-animated | Styles applied to the input element if disableAnimation={false} . |
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 thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.
Inheritance
The props of the FormLabel component are also available. You can take advantage of this behavior to target nested components.