Skip to content
Edit this page

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.

children

Node passed into the SVG element.

Type:

node
classes

Override or extend the styles applied to the component.

Type:

object
color

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.

Type:

'inherit' | 'action' | 'disabled' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string

Default:

'inherit'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
fontSize

The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.

Type:

'inherit' | 'large' | 'medium' | 'small' | string

Default:

'medium'
htmlColor

Applies a color attribute to the SVG element.

Type:

string
inheritViewBox

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.

Type:

bool

Default:

false
shapeRendering

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.

Type:

string
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
titleAccess

Provides a human-readable title for the element that contains it. https://www.w3.org/TR/SVG-access/#Equivalent

Type:

string
viewBox

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.

Type:

string

Default:

'0 0 24 24'
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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiSvgIcon-rootroot

Styles applied to the root element.

.MuiSvgIcon-colorPrimarycolorPrimary

Styles applied to the root element if color="primary".

.MuiSvgIcon-colorSecondarycolorSecondary

Styles applied to the root element if color="secondary".

.MuiSvgIcon-colorActioncolorAction

Styles applied to the root element if color="action".

.MuiSvgIcon-colorErrorcolorError

Styles applied to the root element if color="error".

.MuiSvgIcon-colorDisabledcolorDisabled

Styles applied to the root element if color="disabled".

.MuiSvgIcon-fontSizeInheritfontSizeInherit

Styles applied to the root element if fontSize="inherit".

.MuiSvgIcon-fontSizeSmallfontSizeSmall

Styles applied to the root element if fontSize="small".

.MuiSvgIcon-fontSizeMediumfontSizeMedium

Styles applied to the root element if fontSize="medium".

.MuiSvgIcon-fontSizeLargefontSizeLarge

Styles applied to the root element if fontSize="large".

You can override the style of the component using one of these customization options: