mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
5976d9dcd4
* docs: document src prop on Icon component * Update snippets/icons-required.mdx --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
29 lines
1.3 KiB
Plaintext
29 lines
1.3 KiB
Plaintext
<Info>
|
||
必须提供 `icon` 或 `src` 之一。
|
||
</Info>
|
||
|
||
<ResponseField name="icon" type="string">
|
||
要从图标库中显示的图标。
|
||
|
||
可选值：
|
||
|
||
* 如果在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `fontawesome`，则为 [Font Awesome 图标](https://fontawesome.com/icons) 的名称
|
||
* 如果在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `lucide`，则为 [Lucide 图标](https://lucide.dev/icons) 的名称
|
||
* 如果在 `docs.json` 中将 `icons.library` [属性](/zh/organize/settings#param-icons) 设置为 `tabler`，则为 [Tabler 图标](https://tabler.io/icons) 的名称
|
||
</ResponseField>
|
||
|
||
<ResponseField name="src" type="string">
|
||
用作图标的图像的路径或 URL。当你希望使用自定义图像而不是图标库中的图标时，请使用 `src` 代替 `icon`。
|
||
|
||
可选值：
|
||
|
||
* 项目中图像文件的路径（例如，`/images/my-icon.svg`）
|
||
* 外部托管图像的 URL（例如，`https://example.com/icon.png`）
|
||
</ResponseField>
|
||
|
||
<ResponseField name="iconType" type="string">
|
||
[Font Awesome](https://fontawesome.com/icons) 的图标样式。仅在使用 Font Awesome 图标时有效。
|
||
|
||
可选值：`regular`、`solid`、`light`、`thin`、`sharp-solid`、`duotone`、`brands`。
|
||
</ResponseField>
|