Button API
The API documentation of the Button React component. Learn more about the properties and the CSS customization points.
import Button from '@material-ui/core/Button';Props
| Name | Type | Default | Description |
|---|---|---|---|
| children * | node | The content of the button. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| color | enum: 'default' | 'inherit' | 'primary' | 'secondary' |
'default' | The color of the component. It supports those theme colors that make sense for this component. |
| component | elementType | 'button' | The component used for the root node. Either a string to use a DOM element or a component. |
| disabled | bool | false | If true, the button will be disabled. |
| disableFocusRipple | bool | false | If true, the keyboard focus ripple will be disabled. disableRipple must also be true. |
| disableRipple | bool | If true, the ripple effect will be disabled.⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the focusVisibleClassName. |
|
| fullWidth | bool | false | If true, the button will take up the full width of its container. |
| href | string | The URL to link to when the button is clicked. If defined, an a element will be used as the root node. |
|
| size | enum: 'small' | 'medium' | 'large' |
'medium' | The size of the button. small is equivalent to the dense button styling. |
| variant | enum: 'text' | 'outlined' | 'contained' |
'text' | The variant to use. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (ButtonBase).
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. |
| label | Styles applied to the span element that wraps the children. |
| text | Styles applied to the root element if variant="text". |
| textPrimary | Styles applied to the root element if variant="text" and color="primary". |
| textSecondary | Styles applied to the root element if variant="text" and color="secondary". |
| outlined | Styles applied to the root element if variant="outlined". |
| outlinedPrimary | Styles applied to the root element if variant="outlined" and color="primary". |
| outlinedSecondary | Styles applied to the root element if variant="outlined" and color="secondary". |
| contained | Styles applied to the root element if variant="contained". |
| containedPrimary | Styles applied to the root element if variant="contained" and color="primary". |
| containedSecondary | Styles applied to the root element if variant="contained" and color="secondary". |
| focusVisible | Styles applied to the ButtonBase root element if the button is keyboard focused. |
| disabled | Styles applied to the root element if disabled={true}. |
| colorInherit | Styles applied to the root element if color="inherit". |
| sizeSmall | Styles applied to the root element if size="small". |
| sizeLarge | Styles applied to the root element if size="large". |
| fullWidth | Styles applied to the root element if fullWidth={true}. |
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: MuiButton.
Inheritance
The properties of the ButtonBase component are also available. You can take advantage of this behavior to target nested components.
Notes
The component is fully StrictMode compatible.