MenuButton API - Joy UI

MenuButton API - Joy UISkip to contentSkip to content🚀 Influence MUI's 2026 roadmap! Take our latest Developer SurveySearch…

Joy UIv5.0.0-beta.49Getting startedComponentsAPIsAccordionAccordionDetailsAccordionGroupAccordionSummaryAlertAspectRatioAutocompleteAutocompleteListboxAutocompleteOptionAvatarAvatarGroupBadgeBoxBreadcrumbsButtonButtonGroupCardCardActionsCardContentCardCoverCardOverflowCheckboxChipChipDeleteCircularProgressCssBaselineDialogActionsDialogContentDialogTitleDividerDrawerFormControlFormHelperTextFormLabelGridIconButtonInputLinearProgressLinkListListDividerListItemListItemButtonListItemContentListItemDecoratorListSubheaderMenuMenuButtonMenuItemMenuListModalModalCloseModalDialogModalOverflowOptionRadioRadioGroupScopedCssBaselineSelectSheetSkeletonSliderSnackbarStackStepStepButtonStepIndicatorStepperSvgIconSwitchTabTableTabListTabPanelTabsTextareaToggleButtonGroupTooltipTypographyCustomizationIntegrationsMigrationMenuButton API

API reference docs for the React MenuButton 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:

MenuImport

import MenuButton from '@mui/joy/MenuButton';
// or
import { MenuButton } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

PropsView:table

Props of the native component are also available.

NameTypeDefaultDescriptioncolor'danger'
| 'info'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string'neutral'

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.

loadingIndicatornode

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| 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'outlined'

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 JoyMenuButton to change the default props of this component with the theme.

SlotsView:table

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

Slot nameClass nameDefault componentDescriptionroot.MuiMenuButton-root'button'The component that renders the root.startDecorator.MuiMenuButton-startDecorator'span'The component that renders the start decorator.endDecorator.MuiMenuButton-endDecorator'span'The component that renders the end decorator.loadingIndicatorCenter.MuiMenuButton-loadingIndicatorCenter'span'The component that renders the loading indicator center.CSS classesView:table

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription.Mui-disabledState class applied to the root element if disabled={true}..MuiMenuButton-colorContextcolorContextClass name applied to the root element when color inversion is triggered..MuiMenuButton-colorDangercolorDangerClass name applied to the root element if color="danger"..MuiMenuButton-colorInfocolorInfoClass name applied to the root element if color="info"..MuiMenuButton-colorNeutralcolorNeutralClass name applied to the root element if color="neutral"..MuiMenuButton-colorPrimarycolorPrimaryClass name applied to the root element if color="primary"..MuiMenuButton-colorSuccesscolorSuccessClass name applied to the root element if color="success"..MuiMenuButton-colorWarningcolorWarningClass name applied to the root element if color="warning"..MuiMenuButton-fullWidthfullWidthClass name applied to the root element if fullWidth={true}..MuiMenuButton-loadingloadingClass name applied to the root element if loading={true}..MuiMenuButton-sizeLgsizeLgClass name applied to the root element if size="lg"..MuiMenuButton-sizeMdsizeMdClass name applied to the root element if size="md"..MuiMenuButton-sizeSmsizeSmClass name applied to the root element if size="sm"..MuiMenuButton-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined"..MuiMenuButton-variantPlainvariantPlainClass name applied to the root element if variant="plain"..MuiMenuButton-variantSoftvariantSoftClass name applied to the root element if variant="soft"..MuiMenuButton-variantSolidvariantSolidClass name applied to the root element if variant="solid".

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 styleOverrides property in a custom theme. Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.

Edit this page

Was this page helpful?

MenuMenuItem

•

Blog

•

Store

Contents

DemosImportPropscolorcomponentdisabledendDecoratorfullWidthloadingloadingIndicatorloadingPositionsizeslotPropsslotsstartDecoratorsxvariantSlotsrootstartDecoratorendDecoratorloadingIndicatorCenterCSS classesdisabledcolorContextcolorDangercolorInfocolorNeutralcolorPrimarycolorSuccesscolorWarningfullWidthloadingsizeLgsizeMdsizeSmvariantOutlinedvariantPlainvariantSoftvariantSolidSource codeBecome a Diamond sponsorMUI stands in solidarity with Ukraine.Search…