图标容器
为 SVG 路径或字体图形提供原生尺寸、颜色和语义。
本指南覆盖默认 Emotion 环境的 Material UI Core;扩展包与额外示例按清单单独标注。
使用场景与业务边界
SvgIcon/Icon 包装器不是整套图标目录;字体图标需要真实字体资源,装饰图标应隐藏语义。
原生组成与范围
Icon, SvgIcon
保持 Material UI 原生组合与类型,不替换为 JGuang/Base UI/Radix 同名 API。示例条目不是额外组件。
原生安装与初始化
npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1
采用原生 npm 包与 Emotion,不提供虚构的 JGuang UI Registry 地址。将示例放在原生 ThemeProvider 内,按项目选择 CssBaseline 或 ScopedCssBaseline。先检查 React、现有 Provider、锁文件与 SSR 配置;不要覆盖用户文件或忽略 peer 冲突。本批实际验收 React 19.2.8;React 18 及以下须匹配 react-is。完整初始化规则见随附的双语 setup 文档。
关键原生参数
仅解释本指南选出的关键参数,不是平铺的通用 API。原生继承来源、slot 结构、可空值与泛型仍按固定源码保留。
| 所属组件.属性 | 用途说明 | 声明来源 |
|---|---|---|
SvgIcon.viewBox | SVG 坐标系统,不是渲染后的 CSS 尺寸。 | SvgIcon |
SvgIcon.titleAccess | 可访问 SVG 标题,装饰性 SVG 通常不提供标题并保持隐藏。 | SvgIcon |
SvgIcon.fontSize | 原生图标尺寸枚举,与主题关联,不是通用任意尺寸 API。 | SvgIcon |
Icon.baseClassName | 字体图标 CSS 类名,须加载真实匹配的字体资源。 | Icon |
可运行原生示例
下列机器键只选择示例入口,不会作为通用 variant 属性传入每个组件。原生示例 JSX 与数据保持上游原文;JGuang 编写的验收示例明确标注。
- 使用方法 ·
SvgMaterialIcons· 上游原生示例 - SVG 图标容器 ·
SvgIconChildren· 上游原生示例 - 颜色 ·
SvgIconsColor· 上游原生示例 - 尺寸 ·
SvgIconsSize· 上游原生示例 - 创建 SVG 图标 ·
CreateSvgIcon· 上游原生示例 - Material 字体图标 ·
Icons· 上游原生示例 - 自定义字体图标 ·
TwoToneIcons· 上游原生示例
尚未支持的额外示例
这些条目仍保留在上游清单中,不静默跳过,也不展示为已完成预览。需要补充依赖/框架验收后再纳入可运行列表。
- Font Awesome 字体扩展 ·
FontAwesomeIcon:fg-loadcss - Font Awesome 字体扩展 ·
FontAwesomeIconSize:fg-loadcss
真实使用示例
固定版本的未修改原生示例;复制时同时保留所需的局部辅助文件。
import Box from '@mui/material/Box';
import Grid from '@mui/material/Grid';
import Typography from '@mui/material/Typography';
import DeleteIcon from '@mui/icons-material/Delete';
import DeleteOutlinedIcon from '@mui/icons-material/DeleteOutlined';
import DeleteRoundedIcon from '@mui/icons-material/DeleteRounded';
import DeleteTwoToneIcon from '@mui/icons-material/DeleteTwoTone';
import DeleteSharpIcon from '@mui/icons-material/DeleteSharp';
import DeleteForeverIcon from '@mui/icons-material/DeleteForever';
import DeleteForeverOutlinedIcon from '@mui/icons-material/DeleteForeverOutlined';
import DeleteForeverRoundedIcon from '@mui/icons-material/DeleteForeverRounded';
import DeleteForeverTwoToneIcon from '@mui/icons-material/DeleteForeverTwoTone';
import DeleteForeverSharpIcon from '@mui/icons-material/DeleteForeverSharp';
import ThreeDRotationIcon from '@mui/icons-material/ThreeDRotation';
import FourKIcon from '@mui/icons-material/FourK';
import ThreeSixtyIcon from '@mui/icons-material/ThreeSixty';
export default function SvgMaterialIcons() {
return (
<Box sx={{ flexGrow: 1 }}>
<Grid container sx={{ color: 'text.primary' }}>
<Grid size={4}>
<Typography>Filled</Typography>
</Grid>
<Grid size={8}>
<DeleteIcon />
<DeleteForeverIcon />
</Grid>
<Grid size={4}>
<Typography>Outlined</Typography>
</Grid>
<Grid size={8}>
<DeleteOutlinedIcon />
<DeleteForeverOutlinedIcon />
</Grid>
<Grid size={4}>
<Typography>Rounded</Typography>
</Grid>
<Grid size={8}>
<DeleteRoundedIcon />
<DeleteForeverRoundedIcon />
</Grid>
<Grid size={4}>
<Typography>Two Tone</Typography>
</Grid>
<Grid size={8}>
<DeleteTwoToneIcon />
<DeleteForeverTwoToneIcon />
</Grid>
<Grid size={4}>
<Typography>Sharp</Typography>
</Grid>
<Grid size={8}>
<DeleteSharpIcon />
<DeleteForeverSharpIcon />
</Grid>
<Grid size={4}>
<Typography>Edge-cases</Typography>
</Grid>
<Grid size={8}>
<ThreeDRotationIcon />
<FourKIcon />
<ThreeSixtyIcon />
</Grid>
</Grid>
</Box>
);
}
示例依赖边界
@mui/material/Box, @mui/material/Grid, @mui/material/Typography, @mui/icons-material/Delete, @mui/icons-material/DeleteOutlined, @mui/icons-material/DeleteRounded, @mui/icons-material/DeleteTwoTone, @mui/icons-material/DeleteSharp, @mui/icons-material/DeleteForever, @mui/icons-material/DeleteForeverOutlined, @mui/icons-material/DeleteForeverRounded, @mui/icons-material/DeleteForeverTwoTone, @mui/icons-material/DeleteForeverSharp, @mui/icons-material/ThreeDRotation, @mui/icons-material/FourK, @mui/icons-material/ThreeSixty, @mui/material/SvgIcon, @mui/material/Stack, @mui/material/colors, @mui/material/utils, @mui/material/Icon, @mui/material/styles
直接导入 Icons/System/Utils 的示例需要匹配 9.4.0 包。局部数据与辅助文件属于示例闭包,不是额外组件。远程图片和模拟操作不提供后端。
固定上游 API 元数据参考
以下表格保留上游元数据,不是重新推断的通用类型体系。条件泛型、继承属性与回调细节以以下源码声明为准。主题默认配置可能覆盖元数据默认值。
Icon
import Icon from '@mui/material/Icon';
import { Icon } from '@mui/material';
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
baseClassName | 否 | string | 'material-icons' |
children | 否 | node | — |
classes | 否 | object | — |
color | 否 | 'inherit' | 'action' | 'disabled' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'inherit' |
component | 否 | elementType | — |
fontSize | 否 | 'inherit' | 'large' | 'medium' | 'small' | string | 'medium' |
sx | 否 | Array<func | object | bool> | func | object | — |
SvgIcon
import SvgIcon from '@mui/material/SvgIcon';
import { SvgIcon } from '@mui/material';
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
children | 否 | node | — |
classes | 否 | object | — |
color | 否 | 'inherit' | 'action' | 'disabled' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'inherit' |
component | 否 | elementType | — |
fontSize | 否 | 'inherit' | 'large' | 'medium' | 'small' | string | 'medium' |
htmlColor | 否 | string | — |
inheritViewBox | 否 | bool | false |
shapeRendering | 否 | string | — |
sx | 否 | Array<func | object | bool> | func | object | — |
titleAccess | 否 | string | — |
viewBox | 否 | string | '0 0 24 24' |
原生源码声明
声明与 import 从固定源码提取,不平铺联合类型或外部继承。英文注释/类型属于原始源码参考,不代表上游正文已全文翻译。共享类型仍位于原生包中。
vendor/src/Icon/Icon.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { Theme } from '../styles';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
import { IconClasses } from './iconClasses';
export interface IconPropsSizeOverrides {}
export interface IconPropsColorOverrides {}
export interface IconOwnProps {
/**
* The base class applied to the icon. Defaults to 'material-icons', but can be changed to any
* other base class that suits the icon font you're using (for example material-icons-rounded, fas, etc).
* @default 'material-icons'
*/
baseClassName?: string | undefined;
/**
* The name of the icon font ligature.
*/
children?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<IconClasses> | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* @default 'inherit'
*/
color?:
| OverridableStringUnion<
| 'inherit'
| 'action'
| 'disabled'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning',
IconPropsColorOverrides
>
| undefined;
/**
* The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.
* @default 'medium'
*/
fontSize?:
| OverridableStringUnion<'inherit' | 'large' | 'medium' | 'small', IconPropsSizeOverrides>
| undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
}
export interface IconTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'span',
> {
props: AdditionalProps & IconOwnProps;
defaultComponent: RootComponent;
}
declare const Icon: OverridableComponent<IconTypeMap> & { muiName: string };
export type IconProps<
RootComponent extends React.ElementType = IconTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<IconTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
vendor/src/SvgIcon/SvgIcon.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { Theme } from '../styles';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
import { SvgIconClasses } from './svgIconClasses';
export interface SvgIconPropsSizeOverrides {}
export interface SvgIconPropsColorOverrides {}
export interface SvgIconOwnProps {
/**
* Node passed into the SVG element.
*/
children?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<SvgIconClasses> | undefined;
/**
* The color of the component.
* It supports both default and custom theme colors, which can be added as shown in the
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
* You can use the `htmlColor` prop to apply a color attribute to the SVG element.
* @default 'inherit'
*/
color?:
| OverridableStringUnion<
| 'inherit'
| 'action'
| 'disabled'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning',
SvgIconPropsColorOverrides
>
| undefined;
/**
* The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.
* @default 'medium'
*/
fontSize?:
| OverridableStringUnion<'inherit' | 'large' | 'medium' | 'small', SvgIconPropsSizeOverrides>
| undefined;
/**
* Applies a color attribute to the SVG element.
*/
htmlColor?: string | undefined;
/**
* 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.
* @default false
*/
inheritViewBox?: boolean | undefined;
/**
* The shape-rendering attribute. The behavior of the different options is described on the
* [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/SVG/Reference/Attribute/shape-rendering).
* If you are having issues with blurry icons you should investigate this prop.
*/
shapeRendering?: string | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* Provides a human-readable title for the element that contains it.
* https://www.w3.org/TR/SVG-access/#Equivalent
*/
titleAccess?: string | undefined;
/**
* 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.
* @default '0 0 24 24'
*/
viewBox?: string | undefined;
}
export interface SvgIconTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'svg',
> {
props: AdditionalProps & SvgIconOwnProps;
defaultComponent: RootComponent;
}
declare const SvgIcon: OverridableComponent<SvgIconTypeMap> & { muiName: string };
export type SvgIconProps<
RootComponent extends React.ElementType = SvgIconTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<SvgIconTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
安装后验收
执行严格类型检查、生产构建和实际交互。检查键盘标签/焦点、原生支持的禁用/错误/只读语义、深浅色、窄屏和减少动画。按真实宿主数据检查回调,不把复制提示词当作安装完成。初始化工具还需检查服务端 HTML 与无告警水合。
来源与许可
https://github.com/mui/material-ui/tree/809a7717b4c050ba3f69b75300689f07c050a16e
MIT · @mui/material@9.4.0. 保留上游原始内容与许可证。上游完整原文保留于 vendor/docs,不标为全文中文化。