跳转到内容

IconButton API

想要学习更多组件属性和 CSS API,可以查阅 React IconButton 组件的 API 文档。

导入

import IconButton from '@mui/material/IconButton';
// 或
import { IconButton } from '@mui/material';
您可以通过 阅读本指南以最小化捆包大小 来了解这种差异。

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

组件名称

The name MuiIconButton can be used when providing default props or style overrides in the theme.

属性

ButtonBase 组件的属性也是可用的。

名称类型默认值描述
childrennode
The icon element.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'inherit'
| 'default'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'default'
The color of the component. It supports those theme colors that make sense for this component.
disabledboolfalse
如果被设置为 true,那么该组件将会被禁用。
disableFocusRippleboolfalse
If true, the keyboard focus ripple is disabled.
disableRippleboolfalse
If true, the ripple effect is disabled.
⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the focusVisibleClassName.
edge'end'
| 'start'
| false
false
如果传入参数,则使用负边距来抵消一侧的填充(这通常有助于将图标的左侧或右侧与上方或下方的内容对齐,而不会破坏边框的大小和形状)。
size'small'
| 'medium'
| 'large'
| string
'medium'
The size of the button. small is equivalent to the dense button styling.
sxArray<func
| 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.

ref 则会被传递到根元素中。

继承

尽管上文没有明确记载, <1>ButtonBase 组件 的 props 也在 IconButton上可用。 您可以将此用于 <3>目标嵌套组件

CSS

规则名称全局类名描述
root.MuiIconButton-rootStyles applied to the root element.
edgeStart.MuiIconButton-edgeStartStyles applied to the root element if edge="start".
edgeEnd.MuiIconButton-edgeEndStyles applied to the root element if edge="end".
colorInherit.MuiIconButton-colorInheritStyles applied to the root element if color="inherit".
colorPrimary.MuiIconButton-colorPrimaryStyles applied to the root element if color="primary".
colorSecondary.MuiIconButton-colorSecondaryStyles applied to the root element if color="secondary".
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
sizeSmall.MuiIconButton-sizeSmallStyles applied to the root element if size="small".
sizeMedium.MuiIconButton-sizeMediumStyles applied to the root element if size="medium".
sizeLarge.MuiIconButton-sizeLargeStyles applied to the root element if size="large".

您可以使用组件自定义选项对组件进行个性化:

演示项目