SvgIconAPI

React SvgIcon 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。

演示

有关此 React 组件用法的示例和详细信息，请访问组件演示页面

导入

import SvgIcon from '@mui/material/SvgIcon';
// or
import { SvgIcon } from '@mui/material';

通过阅读关于最小化 bundle size 的指南，了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称	类型	默认值	描述
children	node	-	传递到 SVG 元素中的 Node。
classes	object	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参见下方的CSS 类 API。
color	'inherit' \| 'action' \| 'disabled' \| 'primary' \| 'secondary' \| 'error' \| 'info' \| 'success' \| 'warning' \| string	'inherit'	组件的颜色。它同时支持默认主题颜色和自定义主题颜色，自定义主题颜色可以按照调色板自定义指南中所示的方式添加。您可以使用 `htmlColor` prop 将颜色属性应用于 SVG 元素。
component	elementType	-	用于根节点的组件。可以是用于 HTML 元素的字符串或组件。
fontSize	'inherit' \| 'large' \| 'medium' \| 'small' \| string	'medium'	应用于图标的 fontSize。默认为 24px，但可以配置为继承字体大小。
htmlColor	string	-	将颜色属性应用于 SVG 元素。
inheritViewBox	bool	false	如果为 `true`，则根节点将继承自定义 `component` 的 viewBox，并且 `viewBox` prop 将被忽略。当您想引用自定义 `component` 并让 `SvgIcon` 将该 `component` 的 viewBox 传递给根节点时，此属性非常有用。
shapeRendering	string	-	shape-rendering 属性。不同选项的行为在 MDN Web Docs 上进行了描述。如果您在模糊图标方面遇到问题，您应该研究此 prop。
sx	Array<func \| object \| bool> \| func \| object	-	允许定义系统覆盖以及其他 CSS 样式的系统属性。有关更多详细信息，请参见 `sx` 页面。
titleAccess	string	-	为包含它的元素提供人类可读的标题。https://www.w3.org/TR/SVG-access/#Equivalent
viewBox	string	'0 0 24 24'	允许您重新定义 SVG 元素内部不带单位的坐标的含义。例如，如果 SVG 元素是 500（宽度）x 200（高度），并且您传递 viewBox="0 0 50 20"，这意味着 SVG 内部的坐标将从左上角 (0,0) 到右下角 (50,20) 变化，并且每个单位值 10px。

ref 被转发到根元素。

主题默认 props

您可以使用 MuiSvgIcon 通过主题更改此组件的默认 props。

CSS 类

这些类名对于使用 CSS 设置样式很有用。当触发特定状态时，它们将应用于组件的插槽。

类名	规则名称	描述
.MuiSvgIcon-colorAction	colorAction	如果 `color="action"`，则应用于根元素的样式。
.MuiSvgIcon-colorDisabled	colorDisabled	如果 `color="disabled"`，则应用于根元素的样式。
.MuiSvgIcon-colorError	colorError	如果 `color="error"`，则应用于根元素的样式。
.MuiSvgIcon-colorPrimary	colorPrimary	如果 `color="primary"`，则应用于根元素的样式。
.MuiSvgIcon-colorSecondary	colorSecondary	如果 `color="secondary"`，则应用于根元素的样式。
.MuiSvgIcon-fontSizeInherit	fontSizeInherit	如果 `fontSize="inherit"`，则应用于根元素的样式。
.MuiSvgIcon-fontSizeLarge	fontSizeLarge	如果 `fontSize="large"`，则应用于根元素的样式。
.MuiSvgIcon-fontSizeMedium	fontSizeMedium	如果 `fontSize="medium"`，则应用于根元素的样式。
.MuiSvgIcon-fontSizeSmall	fontSizeSmall	如果 `fontSize="small"`，则应用于根元素的样式。
.MuiSvgIcon-root	root	应用于根元素的样式。

您可以使用以下自定义选项之一来覆盖组件的样式

使用全局类名。
使用规则名称作为自定义主题中组件的styleOverrides 属性的一部分。

源代码

如果您在此页面中找不到信息，请考虑查看组件的实现以获取更多详细信息。