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.

Component demos

Import

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.

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

color

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

Type:'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'error'
| 'info'
| 'warning'
| string

Default:'primary'

component

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

Type:elementType

disabled

If true, the component is disabled.

Type:bool

Default:false

disableElevation

If true, no elevation is used.

Type:bool

Default:false

disableFocusRipple

If true, the keyboard focus ripple is disabled.

Type:bool

Default:false

disableRipple

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.

Type:bool

Default:false

endIcon

Element placed after the children.

Type:node

fullWidth

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

Type:bool

Default:false

href

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

Type:string

size

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

Type:'small'
| 'medium'
| 'large'
| string

Default:'medium'

startIcon

Element placed before the children.

Type:node

sx

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

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

variant

The variant to use.

Type:'contained'
| 'outlined'
| 'text'
| string

Default:'text'

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.

.Mui-disabledSTATE

State class applied to the root element if disabled={true}.

.Mui-focusVisibleSTATE

State class applied to the ButtonBase root element if the button is keyboard focused.

.MuiButton-colorInherit

Styles applied to the root element if color="inherit".

Rule name:colorInherit

.MuiButton-contained

Styles applied to the root element if variant="contained".

Rule name:contained

.MuiButton-containedError

Styles applied to the root element if variant="contained" and color="error".

Rule name:containedError

.MuiButton-containedInfo

Styles applied to the root element if variant="contained" and color="info".

Rule name:containedInfo

.MuiButton-containedInherit

Styles applied to the root element if variant="contained" and color="inherit".

Rule name:containedInherit

.MuiButton-containedPrimary

Styles applied to the root element if variant="contained" and color="primary".

Rule name:containedPrimary

.MuiButton-containedSecondary

Styles applied to the root element if variant="contained" and color="secondary".

Rule name:containedSecondary

.MuiButton-containedSizeLarge

Styles applied to the root element if size="large" and variant="contained".

Rule name:containedSizeLarge

.MuiButton-containedSizeMedium

Styles applied to the root element if size="medium" and variant="contained".

Rule name:containedSizeMedium

.MuiButton-containedSizeSmall

Styles applied to the root element if size="small" and variant="contained".

Rule name:containedSizeSmall

.MuiButton-containedSuccess

Styles applied to the root element if variant="contained" and color="success".

Rule name:containedSuccess

.MuiButton-containedWarning

Styles applied to the root element if variant="contained" and color="warning".

Rule name:containedWarning

.MuiButton-disableElevation

Styles applied to the root element if disableElevation={true}.

Rule name:disableElevation

.MuiButton-endIcon

Styles applied to the endIcon element if supplied.

Rule name:endIcon

.MuiButton-fullWidth

Styles applied to the root element if fullWidth={true}.

Rule name:fullWidth

.MuiButton-iconSizeLarge

Styles applied to the icon element if supplied and size="large".

Rule name:iconSizeLarge

.MuiButton-iconSizeMedium

Styles applied to the icon element if supplied and size="medium".

Rule name:iconSizeMedium

.MuiButton-iconSizeSmall

Styles applied to the icon element if supplied and size="small".

Rule name:iconSizeSmall

.MuiButton-outlined

Styles applied to the root element if variant="outlined".

Rule name:outlined

.MuiButton-outlinedError

Styles applied to the root element if variant="outlined" and color="error".

Rule name:outlinedError

.MuiButton-outlinedInfo

Styles applied to the root element if variant="outlined" and color="info".

Rule name:outlinedInfo

.MuiButton-outlinedInherit

Styles applied to the root element if variant="outlined" and color="inherit".

Rule name:outlinedInherit

.MuiButton-outlinedPrimary

Styles applied to the root element if variant="outlined" and color="primary".

Rule name:outlinedPrimary

.MuiButton-outlinedSecondary

Styles applied to the root element if variant="outlined" and color="secondary".

Rule name:outlinedSecondary

.MuiButton-outlinedSizeLarge

Styles applied to the root element if size="large" and variant="outlined".

Rule name:outlinedSizeLarge

.MuiButton-outlinedSizeMedium

Styles applied to the root element if size="medium" and variant="outlined".

Rule name:outlinedSizeMedium

.MuiButton-outlinedSizeSmall

Styles applied to the root element if size="small" and variant="outlined".

Rule name:outlinedSizeSmall

.MuiButton-outlinedSuccess

Styles applied to the root element if variant="outlined" and color="success".

Rule name:outlinedSuccess

.MuiButton-outlinedWarning

Styles applied to the root element if variant="outlined" and color="warning".

Rule name:outlinedWarning

.MuiButton-root

Styles applied to the root element.

Rule name:root

.MuiButton-sizeLarge

Styles applied to the root element if size="large".

Rule name:sizeLarge

.MuiButton-sizeMedium

Styles applied to the root element if size="medium".

Rule name:sizeMedium

.MuiButton-sizeSmall

Styles applied to the root element if size="small".

Rule name:sizeSmall

.MuiButton-startIcon

Styles applied to the startIcon element if supplied.

Rule name:startIcon

.MuiButton-text

Styles applied to the root element if variant="text".

Rule name:text

.MuiButton-textError

Styles applied to the root element if variant="text" and color="error".

Rule name:textError

.MuiButton-textInfo

Styles applied to the root element if variant="text" and color="info".

Rule name:textInfo

.MuiButton-textInherit

Styles applied to the root element if variant="text" and color="inherit".

Rule name:textInherit

.MuiButton-textPrimary

Styles applied to the root element if variant="text" and color="primary".

Rule name:textPrimary

.MuiButton-textSecondary

Styles applied to the root element if variant="text" and color="secondary".

Rule name:textSecondary

.MuiButton-textSizeLarge

Styles applied to the root element if size="large" and variant="text".

Rule name:textSizeLarge

.MuiButton-textSizeMedium

Styles applied to the root element if size="medium" and variant="text".

Rule name:textSizeMedium

.MuiButton-textSizeSmall

Styles applied to the root element if size="small" and variant="text".

Rule name:textSizeSmall

.MuiButton-textSuccess

Styles applied to the root element if variant="text" and color="success".

Rule name:textSuccess

.MuiButton-textWarning

Styles applied to the root element if variant="text" and color="warning".

Rule name:textWarning


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