跳到内容跳到内容
🚀 影响 Joy UI 2025 年路线图！参与最新的开发者调查

按钮组API

React ButtonGroup 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

导入

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

阅读这篇关于最小化 bundle 大小的指南，了解它们之间的区别。

属性

原生组件的属性也可用。

名称类型默认值描述
buttonFlexnumber
| string		-

按钮的 flex 值。

childrennode-

如果未设置 src，则用于在 ButtonGroup 内部渲染图标或文本元素。可以是元素，也可以只是字符串。

颜色'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string		'neutral'

组件的颜色。它支持对此组件有意义的那些主题颜色。

要了解如何添加自己的颜色，请查看主题组件 - 扩展颜色。

componentelementType-

用于根节点的组件。可以是用于 HTML 元素的字符串，也可以是组件。

disabledboolfalse

如果为 true，则所有按钮都将被禁用。

orientation'horizontal'
| 'vertical'		'horizontal'

组件方向。

尺寸'lg'
| 'md'
| 'sm'
| string		'md'

组件的尺寸。它接受 'sm' 和 'lg' 之间的主题值。

要了解如何向组件添加自定义尺寸，请查看主题组件 - 扩展尺寸。

slotProps{ root?: func
| object }		{}

用于内部每个 slot 的 props。

slots{ root?: elementType }{}

用于内部每个 slot 的组件。

有关更多详细信息，请参见下面的 Slots API。

spacingArray<number
| string>
| number
| { lg?: number
| string, md?: number
| string, sm?: number
| string, xl?: number
| string, xs?: number
| string }
| string		0

定义类型为 item 的组件之间的间距。它只能在类型为 container 的组件上使用。

sxArray<func
| object
| bool>
| func
| object		-

允许定义系统覆盖以及其他 CSS 样式的系统 prop。

有关更多详细信息，请参见 `sx` 页面。

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string		'outlined'

要使用的全局 variant。

要了解如何添加自己的 variants，请查看主题组件 - 扩展 variants。

ref 被转发到根元素。

主题默认属性

您可以使用 JoyButtonGroup 通过主题更改此组件的默认属性。

Slots

要了解如何自定义 slot，请查看覆盖组件结构指南。

Slot 名称类名默认组件描述
root.MuiButtonGroup-root'div'渲染 root 的组件。

CSS 类

这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时，它们会应用于组件的 slots。

类名规则名称描述
.MuiButtonGroup-colorContextcolorContext当颜色反转被触发时，应用于根元素的类名。
.MuiButtonGroup-colorDangercolorDanger如果 color="danger"，则应用于根元素的类名。
.MuiButtonGroup-colorNeutralcolorNeutral如果 color="neutral"，则应用于根元素的类名。
.MuiButtonGroup-colorPrimarycolorPrimary如果 color="primary"，则应用于根元素的类名。
.MuiButtonGroup-colorSuccesscolorSuccess如果 color="success"，则应用于根元素的类名。
.MuiButtonGroup-colorWarningcolorWarning如果 color="warning"，则应用于根元素的类名。
.MuiButtonGroup-horizontalhorizontal如果 orientation="horizontal"，则应用于根元素的类名。
.MuiButtonGroup-sizeLgsizeLg如果 size="lg"，则应用于根元素的类名。
.MuiButtonGroup-sizeMdsizeMd如果 size="md"，则应用于根元素的类名。
.MuiButtonGroup-sizeSmsizeSm如果 size="sm"，则应用于根元素的类名。
.MuiButtonGroup-variantOutlinedvariantOutlined如果 variant="outlined"，则应用于根元素的类名。
.MuiButtonGroup-variantPlainvariantPlain如果 variant="plain"，则应用于根元素的类名。
.MuiButtonGroup-variantSoftvariantSoft如果 variant="soft"，则应用于根元素的类名。
.MuiButtonGroup-variantSolidvariantSolid如果 variant="solid"，则应用于根元素的类名。
.MuiButtonGroup-verticalvertical如果 orientation="vertical"，则应用于根元素的类名。

您可以使用以下定制选项之一来覆盖组件的样式

源代码

如果您在此页面中找不到信息，请考虑查看组件的实现以获取更多详细信息。