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>
27 lines
1.3 KiB
Plaintext
27 lines
1.3 KiB
Plaintext
<Info>
|
|
You must include one of `icon` or `src`.
|
|
</Info>
|
|
|
|
<ResponseField name="icon" type="string">
|
|
The icon to display from an icon library.
|
|
|
|
Options:
|
|
- [Font Awesome icon](https://fontawesome.com/icons) name, if you have the `icons.library` [property](/organize/settings-appearance#param-icons) set to `fontawesome` in your `docs.json`
|
|
- [Lucide icon](https://lucide.dev/icons) name, if you have the `icons.library` [property](/organize/settings-appearance#param-icons) set to `lucide` in your `docs.json`
|
|
- [Tabler icon](https://tabler.io/icons) name, if you have the `icons.library` [property](/organize/settings-appearance#param-icons) set to `tabler` in your `docs.json`
|
|
</ResponseField>
|
|
|
|
<ResponseField name="src" type="string">
|
|
Path or URL to an image to use as the icon. Use `src` instead of `icon` when you want to use a custom image rather than an icon from a library.
|
|
|
|
Options:
|
|
- Path to an image file in your project (for example, `/images/my-icon.svg`)
|
|
- URL to an externally hosted image (for example, `https://example.com/icon.png`)
|
|
</ResponseField>
|
|
|
|
<ResponseField name="iconType" type="string">
|
|
The [Font Awesome](https://fontawesome.com/icons) icon style. Only used with Font Awesome icons.
|
|
|
|
Options: `regular`, `solid`, `light`, `thin`, `sharp-solid`, `duotone`, `brands`.
|
|
</ResponseField>
|