Pular para o conteúdo

SvgIcon API

Documentação da API para o componente React SvgIcon . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import SvgIcon from '@mui/material/SvgIcon';
// ou
import { SvgIcon } from '@mui/material';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Nome do componente

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

Propriedades

Propriedades do componente nativo também estão disponíveis.

NomeTipoPadrãoDescrição
childrennode
Node passed into the SVG element.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
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.

O ref é encaminhado para o elemento raiz.

CSS

Nome da regraClasse globalDescrição
root.MuiSvgIcon-rootEstilos aplicados ao elemento raiz.
colorPrimary.MuiSvgIcon-colorPrimaryEstilos aplicados para o elemento raiz se color="primary".
colorSecondary.MuiSvgIcon-colorSecondaryEstilos aplicados para o elemento raiz se color="secondary".
colorAction.MuiSvgIcon-colorActionEstilos aplicados para o elemento raiz se color="action".
colorError.MuiSvgIcon-colorErrorEstilos aplicados para o elemento raiz se color="error".
colorDisabled.MuiSvgIcon-colorDisabledEstilos aplicados para o elemento raiz se color="disabled".
fontSizeInherit.MuiSvgIcon-fontSizeInheritEstilos aplicados para o elemento raiz se fontSize="inherit".
fontSizeSmall.MuiSvgIcon-fontSizeSmallEstilos aplicados para o elemento raiz se fontSize="small".
fontSizeMedium.MuiSvgIcon-fontSizeMedium
fontSizeLarge.MuiSvgIcon-fontSizeLargeEstilos aplicados para o elemento raiz se fontSize="large".

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Demonstrações