Skip to content

Button API

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

Import

import Button from '@material-ui/core/Button';
// or
import { Button } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

NameTypeDefaultDescription
childrennodeThe content of the button.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'inherit'
| 'primary'
| 'secondary'
'primary'The color of the component. It supports those theme colors that make sense for this component.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalseIf true, the button is disabled.
disableElevationboolfalseIf true, no elevation is used.
disableFocusRippleboolfalseIf true, the keyboard focus ripple is disabled.
disableRippleboolfalseIf true, the ripple effect is 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.
endIconnodeElement placed after the children.
fullWidthboolfalseIf true, the button will take up the full width of its container.
hrefstringThe URL to link to when the button is clicked. If defined, an a element will be used as the root node.
size'large'
| 'medium'
| 'small'
'medium'The size of the button. small is equivalent to the dense button styling.
startIconnodeElement placed before the children.
variant'contained'
| 'outlined'
| 'text'
| string
'text'The variant to use.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (ButtonBase).

Inheritance

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

CSS

Rule nameGlobal classDescription
root.MuiButton-rootStyles applied to the root element.
label.MuiButton-labelStyles applied to the span element that wraps the children.
text.MuiButton-textStyles applied to the root element if variant="text".
textPrimary.MuiButton-textPrimaryStyles applied to the root element if variant="text" and color="primary".
textSecondary.MuiButton-textSecondaryStyles applied to the root element if variant="text" and color="secondary".
outlined.MuiButton-outlinedStyles applied to the root element if variant="outlined".
outlinedPrimary.MuiButton-outlinedPrimaryStyles applied to the root element if variant="outlined" and color="primary".
outlinedSecondary.MuiButton-outlinedSecondaryStyles applied to the root element if variant="outlined" and color="secondary".
contained.MuiButton-containedStyles applied to the root element if variant="contained".
containedPrimary.MuiButton-containedPrimaryStyles applied to the root element if variant="contained" and color="primary".
containedSecondary.MuiButton-containedSecondaryStyles applied to the root element if variant="contained" and color="secondary".
disableElevation.MuiButton-disableElevationStyles applied to the root element if disableElevation={true}.
focusVisible.Mui-focusVisiblePseudo-class applied to the ButtonBase root element if the button is keyboard focused.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
colorInherit.MuiButton-colorInheritStyles applied to the root element if color="inherit".
textSizeSmall.MuiButton-textSizeSmallStyles applied to the root element if size="small" and variant="text".
textSizeLarge.MuiButton-textSizeLargeStyles applied to the root element if size="large" and variant="text".
outlinedSizeSmall.MuiButton-outlinedSizeSmallStyles applied to the root element if size="small" and variant="outlined".
outlinedSizeLarge.MuiButton-outlinedSizeLargeStyles applied to the root element if size="large" and variant="outlined".
containedSizeSmall.MuiButton-containedSizeSmallStyles applied to the root element if size="small" and variant="contained".
containedSizeLarge.MuiButton-containedSizeLargeStyles applied to the root element if size="large" and variant="contained".
sizeSmall.MuiButton-sizeSmallStyles applied to the root element if size="small".
sizeLarge.MuiButton-sizeLargeStyles applied to the root element if size="large".
fullWidth.MuiButton-fullWidthStyles applied to the root element if fullWidth={true}.
startIcon.MuiButton-startIconStyles applied to the startIcon element if supplied.
endIcon.MuiButton-endIconStyles applied to the endIcon element if supplied.
iconSizeSmall.MuiButton-iconSizeSmallStyles applied to the icon element if supplied and `size="small"`.
iconSizeMedium.MuiButton-iconSizeMediumStyles applied to the icon element if supplied and `size="medium"`.
iconSizeLarge.MuiButton-iconSizeLargeStyles applied to the icon element if supplied and `size="large"`.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos