跳转到内容

SvgIcon API

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

导入

import SvgIcon from '@mui/material/SvgIcon';
// 或
import { SvgIcon } from '@mui/material';
你可以阅读这个关于最小化捆绑包的指南以了解以上二者的差异。

组件名称

在主题中,名称“MuiSvgIcon”可用于提供默认属性(props),或者样式覆盖

属性

原生(Native) 组件的属性也是可用的。

名称类型默认值描述
childrennode
Node passed into the SVG element.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'inherit'
| 'action'
| 'disabled'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'inherit'
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. You can use the htmlColor prop to apply a color attribute to the SVG element.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
fontSize'inherit'
| 'large'
| 'medium'
| 'small'
| string
'medium'
The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.
htmlColorstring
Applies a color attribute to the SVG element.
inheritViewBoxboolfalse
Useful when you want to reference a custom component and have SvgIcon pass that component's viewBox to the root node. If true, the root node will inherit the custom component's viewBox and the viewBox prop will be ignored.
shapeRenderingstring
The shape-rendering attribute. The behavior of the different options is described on the MDN Web Docs. If you are having issues with blurry icons you should investigate this prop.
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.
titleAccessstring
Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent
viewBoxstring'0 0 24 24'
Allows you to redefine what the coordinates without units mean inside an SVG element. For example, if the SVG element is 500 (width) by 200 (height), and you pass viewBox="0 0 50 20", this means that the coordinates inside the SVG will go from the top left corner (0,0) to bottom right (50,20) and each unit will be worth 10px.

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

CSS

规则名称全局类名描述
root.MuiSvgIcon-rootStyles applied to the root element.
colorPrimary.MuiSvgIcon-colorPrimaryStyles applied to the root element if color="primary".
colorSecondary.MuiSvgIcon-colorSecondaryStyles applied to the root element if color="secondary".
colorAction.MuiSvgIcon-colorActionStyles applied to the root element if color="action".
colorError.MuiSvgIcon-colorErrorStyles applied to the root element if color="error".
colorDisabled.MuiSvgIcon-colorDisabledStyles applied to the root element if color="disabled".
fontSizeInherit.MuiSvgIcon-fontSizeInheritStyles applied to the root element if fontSize="inherit".
fontSizeSmall.MuiSvgIcon-fontSizeSmallStyles applied to the root element if fontSize="small".
fontSizeMedium.MuiSvgIcon-fontSizeMedium
fontSizeLarge.MuiSvgIcon-fontSizeLargeStyles applied to the root element if fontSize="large".

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

演示项目