[go: up one dir, main page]
Skip to content

Button API

API reference docs for the React Button component. Learn about the props, CSS, and other APIs of this exported module.

DemosImport
import Button from '@mui/material/Button';
// or
import { Button } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the ButtonBase component are also available.

NameTypeDefaultDescription
childrennode-

The content of the component.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

color'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'error'
| 'info'
| 'warning'
| string		'primary'

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

componentelementType-

The component used for the root node. Either a string to use a HTML element or a component.

disabledboolfalse

If true, the component is disabled.

disableElevationboolfalse

If true, no elevation is used.

disableFocusRippleboolfalse

If true, the keyboard focus ripple is disabled.

disableRippleboolfalse

If 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 .Mui-focusVisible class.

endIconnode-

Element placed after the children.

fullWidthboolfalse

If true, the button will take up the full width of its container.

hrefstring-

The URL to link to when the button is clicked. If defined, an a element will be used as the root node.

size'small'
| 'medium'
| 'large'
| string		'medium'

The size of the component. small is equivalent to the dense button styling.

startIconnode-

Element placed before the children.

sxArray<func
| object
| bool>
| func
| object		-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

variant'contained'
| 'outlined'
| 'text'
| string		'text'

The variant to use.

The ref is forwarded to the root element.
Inheritance

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

Theme default props

You can use MuiButton to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.Mui-focusVisibleState class applied to the ButtonBase root element if the button is keyboard focused.
.MuiButton-colorErrorcolorErrorStyles applied to the root element if color="error".
.MuiButton-colorInfocolorInfoStyles applied to the root element if color="info".
.MuiButton-colorInheritcolorInheritStyles applied to the root element if color="inherit".
.MuiButton-colorPrimarycolorPrimaryStyles applied to the root element if color="primary".
.MuiButton-colorSecondarycolorSecondaryStyles applied to the root element if color="secondary".
.MuiButton-colorSuccesscolorSuccessStyles applied to the root element if color="success".
.MuiButton-colorWarningcolorWarningStyles applied to the root element if color="warning".
.MuiButton-containedcontainedStyles applied to the root element if variant="contained".
.MuiButton-containedErrorcontainedErrorStyles applied to the root element if variant="contained" and color="error".
.MuiButton-containedInfocontainedInfoStyles applied to the root element if variant="contained" and color="info".
.MuiButton-containedInheritcontainedInheritStyles applied to the root element if variant="contained" and color="inherit".
.MuiButton-containedPrimarycontainedPrimaryStyles applied to the root element if variant="contained" and color="primary".
.MuiButton-containedSecondarycontainedSecondaryStyles applied to the root element if variant="contained" and color="secondary".
.MuiButton-containedSizeLargecontainedSizeLargeStyles applied to the root element if size="large" and variant="contained".
.MuiButton-containedSizeMediumcontainedSizeMediumStyles applied to the root element if size="medium" and variant="contained".
.MuiButton-containedSizeSmallcontainedSizeSmallStyles applied to the root element if size="small" and variant="contained".
.MuiButton-containedSuccesscontainedSuccessStyles applied to the root element if variant="contained" and color="success".
.MuiButton-containedWarningcontainedWarningStyles applied to the root element if variant="contained" and color="warning".
.MuiButton-disableElevationdisableElevationStyles applied to the root element if disableElevation={true}.
.MuiButton-endIconendIconStyles applied to the endIcon element if supplied.
.MuiButton-fullWidthfullWidthStyles applied to the root element if fullWidth={true}.
.MuiButton-iconiconStyles applied to the icon element if supplied
.MuiButton-iconSizeLargeiconSizeLargeStyles applied to the icon element if supplied and size="large".
.MuiButton-iconSizeMediumiconSizeMediumStyles applied to the icon element if supplied and size="medium".
.MuiButton-iconSizeSmalliconSizeSmallStyles applied to the icon element if supplied and size="small".
.MuiButton-outlinedoutlinedStyles applied to the root element if variant="outlined".
.MuiButton-outlinedErroroutlinedErrorStyles applied to the root element if variant="outlined" and color="error".
.MuiButton-outlinedInfooutlinedInfoStyles applied to the root element if variant="outlined" and color="info".
.MuiButton-outlinedInheritoutlinedInheritStyles applied to the root element if variant="outlined" and color="inherit".
.MuiButton-outlinedPrimaryoutlinedPrimaryStyles applied to the root element if variant="outlined" and color="primary".
.MuiButton-outlinedSecondaryoutlinedSecondaryStyles applied to the root element if variant="outlined" and color="secondary".
.MuiButton-outlinedSizeLargeoutlinedSizeLargeStyles applied to the root element if size="large" and variant="outlined".
.MuiButton-outlinedSizeMediumoutlinedSizeMediumStyles applied to the root element if size="medium" and variant="outlined".
.MuiButton-outlinedSizeSmalloutlinedSizeSmallStyles applied to the root element if size="small" and variant="outlined".
.MuiButton-outlinedSuccessoutlinedSuccessStyles applied to the root element if variant="outlined" and color="success".
.MuiButton-outlinedWarningoutlinedWarningStyles applied to the root element if variant="outlined" and color="warning".
.MuiButton-rootrootStyles applied to the root element.
.MuiButton-sizeLargesizeLargeStyles applied to the root element if size="large".
.MuiButton-sizeMediumsizeMediumStyles applied to the root element if size="medium".
.MuiButton-sizeSmallsizeSmallStyles applied to the root element if size="small".
.MuiButton-startIconstartIconStyles applied to the startIcon element if supplied.
.MuiButton-texttextStyles applied to the root element if variant="text".
.MuiButton-textErrortextErrorStyles applied to the root element if variant="text" and color="error".
.MuiButton-textInfotextInfoStyles applied to the root element if variant="text" and color="info".
.MuiButton-textInherittextInheritStyles applied to the root element if variant="text" and color="inherit".
.MuiButton-textPrimarytextPrimaryStyles applied to the root element if variant="text" and color="primary".
.MuiButton-textSecondarytextSecondaryStyles applied to the root element if variant="text" and color="secondary".
.MuiButton-textSizeLargetextSizeLargeStyles applied to the root element if size="large" and variant="text".
.MuiButton-textSizeMediumtextSizeMediumStyles applied to the root element if size="medium" and variant="text".
.MuiButton-textSizeSmalltextSizeSmallStyles applied to the root element if size="small" and variant="text".
.MuiButton-textSuccesstextSuccessStyles applied to the root element if variant="text" and color="success".
.MuiButton-textWarningtextWarningStyles applied to the root element if variant="text" and color="warning".

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.