按钮组
将相关的原生 Button 连接为一个操作组。
本指南覆盖默认 Emotion 环境的 Material UI Core;扩展包与额外示例按清单单独标注。
使用场景与业务边界
分组不管理选中状态;选择操作使用 ToggleButtonGroup,拆分菜单状态须明确连接。
原生组成与范围
Button, ButtonGroup
保持 Material UI 原生组合与类型,不替换为 JGuang/Base UI/Radix 同名 API。示例条目不是额外组件。
原生安装与初始化
npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1
采用原生 npm 包与 Emotion,不提供虚构的 JGuang UI Registry 地址。将示例放在原生 ThemeProvider 内,按项目选择 CssBaseline 或 ScopedCssBaseline。先检查 React、现有 Provider、锁文件与 SSR 配置;不要覆盖用户文件或忽略 peer 冲突。本批实际验收 React 19.2.8;React 18 及以下须匹配 react-is。完整初始化规则见随附的双语 setup 文档。
关键原生参数
仅解释本指南选出的关键参数,不是平铺的通用 API。原生继承来源、slot 结构、可空值与泛型仍按固定源码保留。
| 所属组件.属性 | 用途说明 | 声明来源 |
|---|---|---|
ButtonGroup.variant | 所属组件的原生视觉枚举,不可替换为通用 variant 属性。 | ButtonGroup |
ButtonGroup.orientation | 原生横向/纵向排列,布局行为取决于所属组件。 | ButtonGroup |
ButtonGroup.disabled | 原生禁用交互状态,不是权限校验。 | ButtonGroup |
ButtonGroup.size | 所属组件的原生尺寸:控件使用枚举,Grid 使用响应式跨列值。 | ButtonGroup |
可运行原生示例
下列机器键只选择示例入口,不会作为通用 variant 属性传入每个组件。原生示例 JSX 与数据保持上游原文;JGuang 编写的验收示例明确标注。
- 基础按钮组 ·
BasicButtonGroup· 上游原生示例 - 按钮变体 ·
VariantButtonGroup· 上游原生示例 - 尺寸与颜色 ·
GroupSizesColors· 上游原生示例 - 纵向分组 ·
GroupOrientation· 上游原生示例 - 拆分按钮 ·
SplitButton· 上游原生示例 - 去除阴影 ·
DisableElevation· 上游原生示例 - 加载状态 ·
LoadingButtonGroup· 上游原生示例
真实使用示例
固定版本的未修改原生示例;复制时同时保留所需的局部辅助文件。
import Button from '@mui/material/Button';
import ButtonGroup from '@mui/material/ButtonGroup';
export default function BasicButtonGroup() {
return (
<ButtonGroup variant="contained" aria-label="Basic button group">
<Button>One</Button>
<Button>Two</Button>
<Button>Three</Button>
</ButtonGroup>
);
}
示例依赖边界
@mui/material/Button, @mui/material/ButtonGroup, @mui/material/Box, react, @mui/icons-material/ArrowDropDown, @mui/material/ClickAwayListener, @mui/material/Grow, @mui/material/Paper, @mui/material/Popper, @mui/material/MenuItem, @mui/material/MenuList, @mui/icons-material/Save
直接导入 Icons/System/Utils 的示例需要匹配 9.4.0 包。局部数据与辅助文件属于示例闭包,不是额外组件。远程图片和模拟操作不提供后端。
固定上游 API 元数据参考
以下表格保留上游元数据,不是重新推断的通用类型体系。条件泛型、继承属性与回调细节以以下源码声明为准。主题默认配置可能覆盖元数据默认值。
Button
import Button from '@mui/material/Button';
import { Button } from '@mui/material';
原生继承: ButtonBase. 父级与 DOM 属性未被伪造为本组件新属性。
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
children | 否 | node | — |
classes | 否 | object | — |
color | 否 | 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning' | string | 'primary' |
component | 否 | elementType | — |
disabled | 否 | bool | false |
disableElevation | 否 | bool | false |
disableFocusRipple | 否 | bool | false |
disableRipple | 否 | bool | false |
endIcon | 否 | node | — |
fullWidth | 否 | bool | false |
href | 否 | string | — |
loading | 否 | bool | null |
loadingIndicator | 否 | node | <CircularProgress color="inherit" size={16} /> |
loadingPosition | 否 | 'center' | 'end' | 'start' | 'center' |
size | 否 | 'small' | 'medium' | 'large' | string | 'medium' |
startIcon | 否 | node | — |
sx | 否 | Array<func | object | bool> | func | object | — |
variant | 否 | 'contained' | 'outlined' | 'text' | string | 'text' |
ButtonGroup
import ButtonGroup from '@mui/material/ButtonGroup';
import { ButtonGroup } from '@mui/material';
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
children | 否 | node | — |
classes | 否 | object | — |
color | 否 | 'inherit' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' |
component | 否 | elementType | — |
disabled | 否 | bool | false |
disableElevation | 否 | bool | false |
disableFocusRipple | 否 | bool | false |
disableRipple | 否 | bool | false |
fullWidth | 否 | bool | false |
orientation | 否 | 'horizontal' | 'vertical' | 'horizontal' |
size | 否 | 'small' | 'medium' | 'large' | string | 'medium' |
sx | 否 | Array<func | object | bool> | func | object | — |
variant | 否 | 'contained' | 'outlined' | 'text' | string | 'outlined' |
原生源码声明
声明与 import 从固定源码提取,不平铺联合类型或外部继承。英文注释/类型属于原始源码参考,不代表上游正文已全文翻译。共享类型仍位于原生包中。
vendor/src/Button/Button.d.ts
import * as React from 'react';
import { DistributiveOmit, OverridableStringUnion } from '@mui/types';
import { SxProps } from '@mui/system';
import { Theme } from '../styles';
import { ExtendButtonBase, ExtendButtonBaseTypeMap } from '../ButtonBase';
import { OverrideProps, OverridableComponent, OverridableTypeMap } from '../OverridableComponent';
import { ButtonClasses } from './buttonClasses';
export interface ButtonPropsVariantOverrides {}
export interface ButtonPropsColorOverrides {}
export interface ButtonPropsSizeOverrides {}
export interface ButtonOwnProps {
/**
* The content of the component.
*/
children?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<ButtonClasses> | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* @default 'primary'
*/
color?:
| OverridableStringUnion<
'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning',
ButtonPropsColorOverrides
>
| undefined;
/**
* If `true`, the component is disabled.
* @default false
*/
disabled?: boolean | undefined;
/**
* If `true`, no elevation is used.
* @default false
*/
disableElevation?: boolean | undefined;
/**
* If `true`, the keyboard focus ripple is disabled.
* @default false
*/
disableFocusRipple?: boolean | undefined;
/**
* Element placed after the children.
*/
endIcon?: React.ReactNode;
/**
* If `true`, the button will take up the full width of its container.
* @default false
*/
fullWidth?: boolean | undefined;
/**
* The URL to link to when the button is clicked.
* If defined, an `a` element will be used as the root node.
*/
href?: string | undefined;
/**
* If `true`, the loading indicator is visible and the button is disabled.
* If `true | false`, the loading wrapper is always rendered before the children to prevent [Google Translation Crash](https://github.com/mui/material-ui/issues/27853).
* @default null
*/
loading?: boolean | null | undefined;
/**
* Element placed before the children if the button is in loading state.
* The node should contain an element with `role="progressbar"` with an accessible name.
* By default, it renders a `CircularProgress` that is labeled by the button itself.
* @default <CircularProgress color="inherit" size={16} />
*/
loadingIndicator?: React.ReactNode;
/**
* The loading indicator can be positioned on the start, end, or the center of the button.
* @default 'center'
*/
loadingPosition?: 'start' | 'end' | 'center' | undefined;
/**
* The size of the component.
* `small` is equivalent to the dense button styling.
* @default 'medium'
*/
size?: OverridableStringUnion<'small' | 'medium' | 'large', ButtonPropsSizeOverrides> | undefined;
/**
* Element placed before the children.
*/
startIcon?: React.ReactNode;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* The variant to use.
* @default 'text'
*/
variant?:
| OverridableStringUnion<'text' | 'outlined' | 'contained', ButtonPropsVariantOverrides>
| undefined;
}
export type ButtonTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'button',
> = ExtendButtonBaseTypeMap<{
props: AdditionalProps & ButtonOwnProps;
defaultComponent: RootComponent;
}>;
export interface ExtendButtonTypeMap<TypeMap extends OverridableTypeMap> {
props: TypeMap['props'] &
(TypeMap['props'] extends { classes?: Record<string, string> | undefined }
? DistributiveOmit<ButtonTypeMap['props'], 'classes'>
: ButtonTypeMap['props']);
defaultComponent: TypeMap['defaultComponent'];
}
export type ExtendButton<TypeMap extends OverridableTypeMap> = ((
props: { href: string } & OverrideProps<ExtendButtonBaseTypeMap<TypeMap>, 'a'>,
) => React.JSX.Element) &
OverridableComponent<ExtendButtonBaseTypeMap<TypeMap>>;
declare const Button: ExtendButtonBase<ButtonTypeMap>;
export type ButtonProps<
RootComponent extends React.ElementType = ButtonTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<ButtonTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
vendor/src/ButtonGroup/ButtonGroup.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
import { Theme } from '../styles';
import { ButtonGroupClasses } from './buttonGroupClasses';
export interface ButtonGroupPropsColorOverrides {}
export interface ButtonGroupPropsVariantOverrides {}
export interface ButtonGroupPropsSizeOverrides {}
export interface ButtonGroupOwnProps {
/**
* The content of the component.
*/
children?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<ButtonGroupClasses> | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* @default 'primary'
*/
color?:
| OverridableStringUnion<
'inherit' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning',
ButtonGroupPropsColorOverrides
>
| undefined;
/**
* If `true`, the component is disabled.
* @default false
*/
disabled?: boolean | undefined;
/**
* If `true`, no elevation is used.
* @default false
*/
disableElevation?: boolean | undefined;
/**
* If `true`, the button keyboard focus ripple is disabled.
* @default false
*/
disableFocusRipple?: boolean | undefined;
/**
* If `true`, the button ripple effect is disabled.
* @default false
*/
disableRipple?: boolean | undefined;
/**
* If `true`, the buttons will take up the full width of its container.
* @default false
*/
fullWidth?: boolean | undefined;
/**
* The component orientation (layout flow direction).
* @default 'horizontal'
*/
orientation?: 'vertical' | 'horizontal' | undefined;
/**
* The size of the component.
* `small` is equivalent to the dense button styling.
* @default 'medium'
*/
size?:
OverridableStringUnion<'small' | 'medium' | 'large', ButtonGroupPropsSizeOverrides> | undefined;
/**
* The variant to use.
* @default 'outlined'
*/
variant?:
| OverridableStringUnion<'text' | 'outlined' | 'contained', ButtonGroupPropsVariantOverrides>
| undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
}
export interface ButtonGroupTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'div',
> {
props: AdditionalProps & ButtonGroupOwnProps;
defaultComponent: RootComponent;
}
declare const ButtonGroup: OverridableComponent<ButtonGroupTypeMap>;
export type ButtonGroupProps<
RootComponent extends React.ElementType = ButtonGroupTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<ButtonGroupTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
安装后验收
执行严格类型检查、生产构建和实际交互。检查键盘标签/焦点、原生支持的禁用/错误/只读语义、深浅色、窄屏和减少动画。按真实宿主数据检查回调,不把复制提示词当作安装完成。初始化工具还需检查服务端 HTML 与无告警水合。
来源与许可
https://github.com/mui/material-ui/tree/809a7717b4c050ba3f69b75300689f07c050a16e
MIT · @mui/material@9.4.0. 保留上游原始内容与许可证。上游完整原文保留于 vendor/docs,不标为全文中文化。