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/joy/Button';
// or
import { Button } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

action

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

Type:func
| { current?: { focusVisible: func } }

color

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.

Type:'danger'
| 'neutral'
| 'primary'
| 'success'
| '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

endDecorator

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

loading

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

Type:bool

Default:false

loadingIndicator

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.

Type:node

Default:<CircularProgress />

loadingPosition

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

Type:'center'
| 'end'
| 'start'

Default:'center'

size

The size of the component.

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

Type:'sm'
| 'md'
| 'lg'
| string

Default:'md'

slotProps

The props used for each slot inside.

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

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

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

Default:{}

startDecorator

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 global variant to use.

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

Type:'outlined'
| 'plain'
| 'soft'
| 'solid'
| string

Default:'solid'

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.

root

The component that renders the root.

Global class: .MuiButton-root

Default: 'button'

startDecorator

The component that renders the start decorator.

Global class: .MuiButton-startDecorator

Default: 'span'

endDecorator

The component that renders the end decorator.

Global class: .MuiButton-endDecorator

Default: 'span'

loadingIndicatorCenter

The component that renders the loading indicator center.

Global class: .MuiButton-loadingIndicatorCenter

Default: 'span'

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot 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-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiButton-colorDanger

Class name applied to the root element if color="danger".

.MuiButton-colorNeutral

Class name applied to the root element if color="neutral".

.MuiButton-colorPrimary

Class name applied to the root element if color="primary".

.MuiButton-colorSuccess

Class name applied to the root element if color="success".

.MuiButton-colorWarning

Class name applied to the root element if color="warning".

.MuiButton-fullWidth

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

.MuiButton-loading

Class name applied to the root element if loading={true}.

.MuiButton-sizeLg

Class name applied to the root element if size="lg".

.MuiButton-sizeMd

Class name applied to the root element if size="md".

.MuiButton-sizeSm

Class name applied to the root element if size="sm".

.MuiButton-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiButton-variantPlain

Class name applied to the root element if variant="plain".

.MuiButton-variantSoft

Class name applied to the root element if variant="soft".

.MuiButton-variantSolid

Class name applied to the root element if variant="solid".