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.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Button from '@mui/joy/Button';
// or
import { Button } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
actionfunc
| { current?: { focusVisible: func } }

A ref for imperative actions. It currently only supports focusVisible() action.

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string		'primary'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

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.

endDecoratornode

Element placed after the children.

fullWidthboolfalse

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

loadingboolfalse

If true, the loading indicator is shown and the button becomes disabled.

loadingIndicatornode<CircularProgress />

The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.

loadingPosition'center'
| 'end'
| 'start'		'center'

The loading indicator can be positioned on the start, end, or the center of the button.

size'sm'
| 'md'
| 'lg'
| string		'md'

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

slotProps{ endDecorator?: func
| object, loadingIndicatorCenter?: func
| object, root?: func
| object, startDecorator?: func
| object }		{}

The props used for each slot inside.

slots{ endDecorator?: elementType, loadingIndicatorCenter?: elementType, root?: elementType, startDecorator?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

startDecoratornode

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'outlined'
| 'plain'
| 'soft'
| 'solid'
| string		'solid'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

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

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefaultDescription
root.MuiButton-root'button'The component that renders the root.
startDecorator.MuiButton-startDecorator'span'The component that renders the start decorator.
endDecorator.MuiButton-endDecorator'span'The component that renders the end decorator.
loadingIndicatorCenter.MuiButton-loadingIndicatorCenter'span'The component that renders the loading indicator center.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Rule 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-colorContextClass name applied to the root element when color inversion is triggered.
.MuiButton-colorDangerClass name applied to the root element if color="danger".
.MuiButton-colorNeutralClass name applied to the root element if color="neutral".
.MuiButton-colorPrimaryClass name applied to the root element if color="primary".
.MuiButton-colorSuccessClass name applied to the root element if color="success".
.MuiButton-colorWarningClass name applied to the root element if color="warning".
.MuiButton-fullWidthClass name applied to the root element if fullWidth={true}.
.MuiButton-loadingClass name applied to the root element if loading={true}.
.MuiButton-sizeLgClass name applied to the root element if size="lg".
.MuiButton-sizeMdClass name applied to the root element if size="md".
.MuiButton-sizeSmClass name applied to the root element if size="sm".
.MuiButton-variantOutlinedClass name applied to the root element if variant="outlined".
.MuiButton-variantPlainClass name applied to the root element if variant="plain".
.MuiButton-variantSoftClass name applied to the root element if variant="soft".
.MuiButton-variantSolidClass name applied to the root element if variant="solid".