IconButton API
导入
import IconButton from '@mui/material/IconButton';
// 或
import { IconButton } from '@mui/material';
Refer to the Icons section of the documentation regarding the available icon options.
组件名称
在主题中,名称“MuiIconButton
”可用于提供默认属性(props),或者样式覆盖属性
ButtonBase 组件的属性也是可用的。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
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' | 'error' | 'info' | 'success' | 'warning' | string | 'default' | The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. |
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 | 如果传入参数,则使用负边距来抵消一侧的填充(这通常有助于将图标的左侧或右侧与上方或下方的内容对齐,而不会破坏边框的大小和形状)。 |
size | 'small' | 'medium' | 'large' | string | 'medium' | The size of the button. small is equivalent to the dense button styling. |
sx | Array<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
则会被传递到根元素中。继承
尽管上文没有明文记录, ButtonBase 组件 的属性(props) 在组件IconButton上同样是可用的。 你可以利用这一点来 指向嵌套组件CSS
规则名称 | 全局类名 | 描述 |
---|---|---|
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" . |
colorError | .MuiIconButton-colorError | |
colorInfo | .MuiIconButton-colorInfo | |
colorSuccess | .MuiIconButton-colorSuccess | |
colorWarning | .MuiIconButton-colorWarning | |
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" . |
sizeMedium | .MuiIconButton-sizeMedium | Styles applied to the root element if size="medium" . |
sizeLarge | .MuiIconButton-sizeLarge | Styles applied to the root element if size="large" . |
您可以使用组件自定义选项对组件进行个性化:
- 具备 全局类名.
- 在自定义主体中,设定一个规则名称作为组件的
styleOverrides
属性的一部分。