VariableIcon API

API reference docs for the React VariableIcon 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 VariableIcon from '@mui/material/VariableIcon';
// or
import { VariableIcon } from '@mui/material';

Name	Type	Default	Description
children	node	-	Node passed into the icon 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.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
emphasis	'heavy' \| 'light' \| 'regular'	-	Allows increasing or decreasing emphasis.
filled	bool	-	Indicates if the icon should be filled.
fontSize	'inherit' \| 'x-large' \| 'large' \| 'medium' \| 'small' \| string	'medium'	The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.
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.
title	string	-	Provides a human-readable title for the element that contains it.

The component cannot hold a ref.

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

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