SvgIcon API

API reference docs for the React SvgIcon component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	Node passed into the SVG element.
classes	object	-	Override or extend the styles applied to the component. See CSS classes 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.
component	elementType	-	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.
htmlColor	string	-	Applies a color attribute to the SVG element.
inheritViewBox	bool	false	If `true`, the root node will inherit the custom `component`'s viewBox and the `viewBox` prop will be ignored. Useful when you want to reference a custom `component` and have `SvgIcon` pass that `component`'s viewBox to the root node.
shapeRendering	string	-	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.
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.
titleAccess	string	-	Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent
viewBox	string	'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.

The ref is forwarded to the root element.

Theme default props

You can use MuiSvgIcon to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiSvgIcon-colorAction	colorAction	Styles applied to the root element if `color="action"`.
.MuiSvgIcon-colorDisabled	colorDisabled	Styles applied to the root element if `color="disabled"`.
.MuiSvgIcon-colorError	colorError	Styles applied to the root element if `color="error"`.
.MuiSvgIcon-colorPrimary	colorPrimary	Styles applied to the root element if `color="primary"`.
.MuiSvgIcon-colorSecondary	colorSecondary	Styles applied to the root element if `color="secondary"`.
.MuiSvgIcon-fontSizeInherit	fontSizeInherit	Styles applied to the root element if `fontSize="inherit"`.
.MuiSvgIcon-fontSizeLarge	fontSizeLarge	Styles applied to the root element if `fontSize="large"`.
.MuiSvgIcon-fontSizeMedium	fontSizeMedium	Styles applied to the root element if `fontSize="medium"`.
.MuiSvgIcon-fontSizeSmall	fontSizeSmall	Styles applied to the root element if `fontSize="small"`.
.MuiSvgIcon-root	root	Styles applied to the root 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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.