Button API
API documentation for the React Button component. Learn about the available props and the CSS API.
Import
import Button from '@mui/material/Button';
// or
import { Button } from '@mui/material';Component name
The nameMuiButton can be used when providing default props or style overrides in the theme.Props
Props of the ButtonBase component are also available.
| 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 | '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. |
| component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
| disabled | bool | false | If true, the component is disabled. |
| disableElevation | bool | false | If true, no elevation is used. |
| disableFocusRipple | bool | false | If true, the keyboard focus ripple is disabled. |
| disableRipple | bool | false | 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. |
| endIcon | node | Element placed after the children. | |
| 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 | 'small' | 'medium' | 'large' | string | 'medium' | The size of the component. small is equivalent to the dense button styling. |
| startIcon | node | Element placed before the children. | |
| sx | Array<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 on Button. You can take advantage of this to target nested components.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiButton-root | Styles applied to the root element. |
| text | .MuiButton-text | Styles applied to the root element if variant="text". |
| textInherit | .MuiButton-textInherit | Styles applied to the root element if variant="text" and color="inherit". |
| textPrimary | .MuiButton-textPrimary | Styles applied to the root element if variant="text" and color="primary". |
| textSecondary | .MuiButton-textSecondary | Styles applied to the root element if variant="text" and color="secondary". |
| textSuccess | .MuiButton-textSuccess | Styles applied to the root element if variant="text" and color="success". |
| textError | .MuiButton-textError | Styles applied to the root element if variant="text" and color="error". |
| textInfo | .MuiButton-textInfo | Styles applied to the root element if variant="text" and color="info". |
| textWarning | .MuiButton-textWarning | Styles applied to the root element if variant="text" and color="warning". |
| outlined | .MuiButton-outlined | Styles applied to the root element if variant="outlined". |
| outlinedInherit | .MuiButton-outlinedInherit | Styles applied to the root element if variant="outlined" and color="inherit". |
| outlinedPrimary | .MuiButton-outlinedPrimary | Styles applied to the root element if variant="outlined" and color="primary". |
| outlinedSecondary | .MuiButton-outlinedSecondary | Styles applied to the root element if variant="outlined" and color="secondary". |
| outlinedSuccess | .MuiButton-outlinedSuccess | Styles applied to the root element if variant="outlined" and color="success". |
| outlinedError | .MuiButton-outlinedError | Styles applied to the root element if variant="outlined" and color="error". |
| outlinedInfo | .MuiButton-outlinedInfo | Styles applied to the root element if variant="outlined" and color="info". |
| outlinedWarning | .MuiButton-outlinedWarning | Styles applied to the root element if variant="outlined" and color="warning". |
| contained | .MuiButton-contained | Styles applied to the root element if variant="contained". |
| containedInherit | .MuiButton-containedInherit | Styles applied to the root element if variant="contained" and color="inherit". |
| containedPrimary | .MuiButton-containedPrimary | Styles applied to the root element if variant="contained" and color="primary". |
| containedSecondary | .MuiButton-containedSecondary | Styles applied to the root element if variant="contained" and color="secondary". |
| containedSuccess | .MuiButton-containedSuccess | Styles applied to the root element if variant="contained" and color="success". |
| containedInfo | .MuiButton-containedInfo | Styles applied to the root element if variant="contained" and color="info". |
| containedError | .MuiButton-containedError | Styles applied to the root element if variant="contained" and color="error". |
| containedWarning | .MuiButton-containedWarning | Styles applied to the root element if variant="contained" and color="warning". |
| disableElevation | .MuiButton-disableElevation | Styles applied to the root element if disableElevation={true}. |
| focusVisible | .Mui-focusVisible | State class applied to the ButtonBase root element if the button is keyboard focused. |
| disabled | .Mui-disabled | State class applied to the root element if disabled={true}. |
| colorInherit | .MuiButton-colorInherit | Styles applied to the root element if color="inherit". |
| textSizeSmall | .MuiButton-textSizeSmall | Styles applied to the root element if size="small" and variant="text". |
| textSizeMedium | .MuiButton-textSizeMedium | Styles applied to the root element if size="medium" and variant="text". |
| textSizeLarge | .MuiButton-textSizeLarge | Styles applied to the root element if size="large" and variant="text". |
| outlinedSizeSmall | .MuiButton-outlinedSizeSmall | Styles applied to the root element if size="small" and variant="outlined". |
| outlinedSizeMedium | .MuiButton-outlinedSizeMedium | Styles applied to the root element if size="medium" and variant="outlined". |
| outlinedSizeLarge | .MuiButton-outlinedSizeLarge | Styles applied to the root element if size="large" and variant="outlined". |
| containedSizeSmall | .MuiButton-containedSizeSmall | Styles applied to the root element if size="small" and variant="contained". |
| containedSizeMedium | .MuiButton-containedSizeMedium | Styles applied to the root element if size="medium" and variant="contained". |
| containedSizeLarge | .MuiButton-containedSizeLarge | Styles applied to the root element if size="large" and variant="contained". |
| sizeSmall | .MuiButton-sizeSmall | Styles applied to the root element if size="small". |
| sizeMedium | .MuiButton-sizeMedium | Styles applied to the root element if size="medium". |
| sizeLarge | .MuiButton-sizeLarge | Styles applied to the root element if size="large". |
| fullWidth | .MuiButton-fullWidth | Styles applied to the root element if fullWidth={true}. |
| startIcon | .MuiButton-startIcon | Styles applied to the startIcon element if supplied. |
| endIcon | .MuiButton-endIcon | Styles applied to the endIcon element if supplied. |
| iconSizeSmall | .MuiButton-iconSizeSmall | Styles applied to the icon element if supplied and size="small". |
| iconSizeMedium | .MuiButton-iconSizeMedium | Styles applied to the icon element if supplied and size="medium". |
| iconSizeLarge | .MuiButton-iconSizeLarge | Styles applied to the icon element if supplied and size="large". |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.