图标

可使用来自流行库、外部 URL，或项目内文件的图标。

使用来自 Font Awesome、Lucide、SVG、外部 URL 或项目文件的图标，丰富你的文档。

Icon example

<Icon icon="flag" size={32} />

​

行内图标

当在句子、段落或标题中使用时，图标会以内联形式呈现。 你可以将图标用于装饰，或用于强化视觉重点。

Inline example

图标在句子、段落或标题中使用时会内联显示。<Icon icon="flag" iconType="solid" /> 使用图标可以起到装饰作用或增强视觉效果。

​

属性

icon · string · 必填

要显示的图标。

可选值：

• 如果在 docs.json 中将 icons.library 属性 设置为 fontawesome，则为 Font Awesome 图标 的名称
• 如果在 docs.json 中将 icons.library 属性 设置为 lucide，则为 Lucide 图标 的名称
• 指向外部托管图标的 URL
• 项目中图标文件的路径

iconType · string

Font Awesome 的图标样式。仅在使用 Font Awesome 图标时有效。

可选值：regular、solid、light、thin、sharp-solid、duotone、brands。

color · string

icon 的颜色，使用十六进制色值（例如 #FF5733）。

size · number

icon 的尺寸（像素）。

className · string

应用于 icon 的自定义 CSS 类名。