Skip to content
Edit this page

SvgIcon API

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

Import

import SvgIcon from '@material-ui/core/SvgIcon';
// or
import { SvgIcon } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiSvgIcon can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeNode passed into the SVG element.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'action'
| 'disabled'
| 'error'
| 'inherit'
| 'primary'
| 'secondary'		'inherit'The color of the component. It supports those theme colors that make sense for this component. You can use the htmlColor prop to apply a color attribute to the SVG element.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
fontSize'default'
| 'inherit'
| 'large'
| 'small'		'default'The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.
htmlColorstringApplies a color attribute to the SVG element.
shapeRenderingstringThe 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.
titleAccessstringProvides 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.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
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".
fontSizeLarge.MuiSvgIcon-fontSizeLargeStyles applied to the root element if fontSize="large".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos