IconButton API

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

Import

import IconButton from '@material-ui/core/IconButton';
// 或
import { IconButton } from '@material-ui/core';

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.

属性

名称	类型	默认值	描述
children	node		The icon element.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
color	'inherit' \| 'default' \| 'primary' \| 'secondary' \| string	'default'	The color of the component. It supports those theme colors that make sense for this component.
disabled	bool	false	如果被设置为 `true`，那么该组件将会被禁用。
disableFocusRipple	bool	false	If `true`, the keyboard focus ripple is disabled.
disableRipple	bool	false	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	'medium' \| 'small' \| string	'medium'	The size of the button. `small` is equivalent to the dense button styling.
sx	object

ref 则会被传递到根元素中。
Any other props supplied will be provided to the root element (ButtonBase).

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 name	Global class	描述
root	.MuiIconButton-root	Styles applied to the root element.
edgeStart	.MuiIconButton-edgeStart	Styles applied to the root element if `edge="start"`.
edgeEnd	.MuiIconButton-edgeEnd	Styles applied to the root element if `edge="end"`.
colorInherit	.MuiIconButton-colorInherit	Styles applied to the root element if `color="inherit"`.
colorPrimary	.MuiIconButton-colorPrimary	Styles applied to the root element if `color="primary"`.
colorSecondary	.MuiIconButton-colorSecondary	Styles applied to the root element if `color="secondary"`.
disabled	.Mui-disabled	Pseudo-class applied to the root element if `disabled={true}`.
sizeSmall	.MuiIconButton-sizeSmall	Styles applied to the root element if `size="small"`.
label	.MuiIconButton-label	Styles applied to the children container element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Demos

Buttons