IconButtonAPI

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

演示

有关此 React 组件用法的示例和详细信息，请访问组件演示页面

Button

导入

import IconButton from '@mui/material/IconButton';
// or
import { IconButton } from '@mui/material';

通过阅读本关于最小化 bundle size 的指南，了解差异。

有关可用的图标选项，请参阅文档的 Icons 部分。

Props

ButtonBase 组件的 Props 也可用。

名称	类型	默认值	描述
children	node	-	要显示的图标。
classes	object	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参阅下面的 CSS 类 API。
color	'inherit' \| 'default' \| 'primary' \| 'secondary' \| 'error' \| 'info' \| 'success' \| 'warning' \| string	'default'	组件的颜色。它同时支持默认主题颜色和自定义主题颜色，自定义主题颜色可以按照调色板自定义指南中所示的方式添加。
disabled	bool	false	如果 `true`，则组件被禁用。
disableFocusRipple	bool	false	如果 `true`，则键盘焦点涟漪效果被禁用。
disableRipple	bool	false	如果 `true`，则涟漪效果被禁用。 ⚠️ 如果没有涟漪效果，默认情况下 :focus-visible 没有样式。请务必通过使用 `.Mui-focusVisible` 类应用单独的样式来突出显示元素。
edge	'end' \| 'start' \| false	false	如果给定，则使用负边距来抵消一侧的内边距（这通常有助于将图标的左侧或右侧与上方或下方的内容对齐，而不会破坏边框大小和形状）。
loading	bool	null	如果 `true`，则加载指示器可见且按钮被禁用。如果 `true \\| false`，则加载包装器始终在 children 之前渲染，以防止 Google Translation Crash。
loadingIndicator	node	<CircularProgress color="inherit" size={16} />	如果按钮处于加载状态，则放置在 children 之前的元素。节点应包含一个带有 `role="progressbar"` 和可访问名称的元素。默认情况下，它渲染一个由按钮本身标记的 `CircularProgress`。
size	'small' \| 'medium' \| 'large' \| string	'medium'	组件的大小。`small` 等同于 dense 按钮样式。
sx	Array<func \| object \| bool> \| func \| object	-	允许定义系统覆盖以及其他 CSS 样式的系统属性。有关更多详细信息，请参阅 `sx` 页面。

ref 被转发到根元素。

继承

虽然上面没有明确记录，但 ButtonBase 组件的 props 也可在 IconButton 中使用。您可以利用这一点来定位嵌套组件。

主题默认 props

您可以使用 MuiIconButton 通过主题更改此组件的默认 props。

CSS 类

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

类名	规则名称	描述
.Mui-disabled		如果 `disabled={true}`，则应用于根元素的状态类。
.MuiIconButton-colorError	colorError	如果 `color="error"`，则应用于根元素的样式。
.MuiIconButton-colorInfo	colorInfo	如果 `color="info"`，则应用于根元素的样式。
.MuiIconButton-colorInherit	colorInherit	如果 `color="inherit"`，则应用于根元素的样式。
.MuiIconButton-colorPrimary	colorPrimary	如果 `color="primary"`，则应用于根元素的样式。
.MuiIconButton-colorSecondary	colorSecondary	如果 `color="secondary"`，则应用于根元素的样式。
.MuiIconButton-colorSuccess	colorSuccess	如果 `color="success"`，则应用于根元素的样式。
.MuiIconButton-colorWarning	colorWarning	如果 `color="warning"`，则应用于根元素的样式。
.MuiIconButton-edgeEnd	edgeEnd	如果 `edge="end"`，则应用于根元素的样式。
.MuiIconButton-edgeStart	edgeStart	如果 `edge="start"`，则应用于根元素的样式。
.MuiIconButton-loading	loading	如果 `loading={true}`，则应用于根元素的样式。
.MuiIconButton-loadingIndicator	loadingIndicator	应用于 loadingIndicator 元素的样式。
.MuiIconButton-loadingWrapper	loadingWrapper	应用于 loadingWrapper 元素的样式。
.MuiIconButton-root	root	应用于根元素的样式。
.MuiIconButton-sizeLarge	sizeLarge	如果 `size="large"`，则应用于根元素的样式。
.MuiIconButton-sizeMedium	sizeMedium	如果 `size="medium"`，则应用于根元素的样式。
.MuiIconButton-sizeSmall	sizeSmall	如果 `size="small"`，则应用于根元素的样式。

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

使用全局类名。
在自定义主题中，使用作为组件的 styleOverrides 属性一部分的规则名称。

源代码

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