MenuButtonAPI
React MenuButton 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。
演示
导入
import MenuButton from '@mui/joy/MenuButton';
// or
import { MenuButton } from '@mui/joy';阅读这篇关于最小化包大小的指南，了解更多区别。
原生组件的 Props 也可用。
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| color | 'danger' | 'info' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 组件的颜色。它支持对此组件有意义的主题颜色。 要了解如何添加自己的颜色，请查看主题组件—扩展颜色。 |
| component | elementType | - | 用于根节点的组件。可以是用于 HTML 元素的字符串，也可以是组件。 |
| disabled | bool | false | 如果 |
| endDecorator | node | - | 放置在子元素之后的元素。 |
| fullWidth | bool | false | 如果 |
| loading | bool | false | 如果 |
| loadingIndicator | node | <CircularProgress /> | 节点应包含一个带有 |
| loadingPosition | 'center' | 'end' | 'start' | 'center' | 加载指示器可以位于按钮的开始、结束或中心位置。 |
| size | 'sm' | 'md' | 'lg' | string | 'md' | 组件的大小。 要了解如何向组件添加自定义大小，请查看主题组件—扩展大小。 |
| slotProps | { endDecorator?: func | object, loadingIndicatorCenter?: func | object, root?: func | object, startDecorator?: func | object } | {} | 用于每个内部插槽的 props。 |
| slots | { endDecorator?: elementType, loadingIndicatorCenter?: elementType, root?: elementType, startDecorator?: elementType } | {} | 用于每个内部插槽的组件。 有关更多详细信息，请参阅下面的 Slots API。 |
| startDecorator | node | - | 放置在子元素之前的元素。 |
| sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统 prop。 有关更多详细信息，请参阅 |
| variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'outlined' | 要使用的全局 variant。 要了解如何添加自己的 variants，请查看主题组件—扩展 variants。 |
ref 被转发到根元素。主题默认 Props
您可以使用 JoyMenuButton 通过主题更改此组件的默认 props。
要了解如何自定义插槽，请查看覆盖组件结构指南。
| 插槽名称 | 类名 | 默认组件 | 描述 |
|---|---|---|---|
| root | .MuiMenuButton-root | 'button' | 渲染根的组件。 |
| startDecorator | .MuiMenuButton-startDecorator | 'span' | 渲染开始装饰器的组件。 |
| endDecorator | .MuiMenuButton-endDecorator | 'span' | 渲染结束装饰器的组件。 |
| loadingIndicatorCenter | .MuiMenuButton-loadingIndicatorCenter | 'span' | 渲染加载指示器中心的组件。 |
这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时，它们会应用于组件的插槽。
| 类名 | 规则名称 | 描述 |
|---|---|---|
| .Mui-disabled | 如果 disabled={true}，则应用于根元素的状态类。 | |
| .MuiMenuButton-colorContext | colorContext | 当颜色反转被触发时，应用于根元素的类名。 |
| .MuiMenuButton-colorDanger | colorDanger | 如果 color="danger"，则应用于根元素的类名。 |
| .MuiMenuButton-colorInfo | colorInfo | 如果 color="info"，则应用于根元素的类名。 |
| .MuiMenuButton-colorNeutral | colorNeutral | 如果 color="neutral"，则应用于根元素的类名。 |
| .MuiMenuButton-colorPrimary | colorPrimary | 如果 color="primary"，则应用于根元素的类名。 |
| .MuiMenuButton-colorSuccess | colorSuccess | 如果 color="success"，则应用于根元素的类名。 |
| .MuiMenuButton-colorWarning | colorWarning | 如果 color="warning"，则应用于根元素的类名。 |
| .MuiMenuButton-fullWidth | fullWidth | 如果 fullWidth={true}，则应用于根元素的类名。 |
| .MuiMenuButton-loading | loading | 如果 loading={true}，则应用于根元素的类名。 |
| .MuiMenuButton-sizeLg | sizeLg | 如果 size="lg"，则应用于根元素的类名。 |
| .MuiMenuButton-sizeMd | sizeMd | 如果 size="md"，则应用于根元素的类名。 |
| .MuiMenuButton-sizeSm | sizeSm | 如果 size="sm"，则应用于根元素的类名。 |
| .MuiMenuButton-variantOutlined | variantOutlined | 如果 variant="outlined"，则应用于根元素的类名。 |
| .MuiMenuButton-variantPlain | variantPlain | 如果 variant="plain"，则应用于根元素的类名。 |
| .MuiMenuButton-variantSoft | variantSoft | 如果 variant="soft"，则应用于根元素的类名。 |
| .MuiMenuButton-variantSolid | variantSolid | 如果 variant="solid"，则应用于根元素的类名。 |
您可以使用以下自定义选项之一覆盖组件的样式
- 使用全局类名。
- 在自定义主题中，使用作为组件的
styleOverrides属性一部分的规则名称。
源代码
如果您在此页面中没有找到所需信息，请考虑查看组件的实现以获取更多详细信息。