Skip to content

StepButton API

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

Component demos

Import

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

Props

Props of the native component are also available.

children

Used to render icon or text elements inside the StepButton if src is not set. This can be an element, or just a string.

Type:node

component

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

Type:elementType

slotProps

The props used for each slot inside.

Type:{ root?: func
| object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

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

The ref is forwarded to the root element.

Theme default props

You can use JoyStepButton 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.

Class name: .MuiStepButton-root

Default component: 'button'