跳转到内容
编辑此页面

IconButton API

API documentation for the React IconButton component. Learn about the available props, and the CSS API.

Import

import IconButton from '@mui/material/IconButton';
// 或
import { IconButton } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Refer to the Icons section of the documentation regarding the available icon options.

Component name

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

属性

Props of the ButtonBase component are also available.

名称类型默认值描述
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
If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).
size'small'
| 'medium'
| 'large'
| string		'medium'
The size of the button. small is equivalent to the dense button styling.
sxfunc
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

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

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available on IconButton. You can take advantage of this to target nested components.

CSS

Rule nameGlobal class描述
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".

You can override the style of the component using one of these customization options:

Demos