FormLabel API
The API documentation of the FormLabel React component. Learn more about the props and the CSS customization points.
Import
import FormLabel from '@material-ui/core/FormLabel';
// or
import { FormLabel } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Component name
The MuiFormLabel
name can be used for providing default props or style overrides at the theme level.
Props
Name | Type | Default | Description |
---|---|---|---|
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. | |
component | elementType | 'label' | The component used for the root node. Either a string to use a HTML element or a component. |
disabled | bool | If true , the label should be displayed in a disabled state. |
|
error | bool | If true , the label should be displayed in an error state. |
|
filled | bool | If true , the label should use filled classes key. |
|
focused | bool | If true , the input of this label is focused (used by FormGroup components). |
|
required | bool | If true , the label will indicate that the input is required. |
The ref
is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).
CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiFormLabel-root | Styles applied to the root element. |
colorSecondary | .MuiFormLabel-colorSecondary | Styles applied to the root element if the color is secondary. |
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} . |
filled | .MuiFormLabel-filled | Pseudo-class applied to the root element if filled={true} . |
required | .Mui-required | Pseudo-class applied to the root element if required={true} . |
asterisk | .MuiFormLabel-asterisk | Styles applied to the asterisk element. |
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.