mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
23 lines
1.1 KiB
Plaintext
23 lines
1.1 KiB
Plaintext
<ResponseField name="icon" type="string">
|
|
The icon to display.
|
|
|
|
Options:
|
|
- [Font Awesome](https://fontawesome.com/icons) icon name, if you have the `icons.library` [property](/organize/settings#param-icons) set to `fontawesome` in your `docs.json`
|
|
- [Lucide](https://lucide.dev/icons) icon name, if you have the `icons.library` [property](/organize/settings#param-icons) set to `lucide` in your `docs.json`
|
|
- URL to an externally hosted icon
|
|
- Path to an icon file in your project
|
|
- SVG code wrapped in curly braces
|
|
|
|
For custom SVG icons:
|
|
1. Convert your SVG using the [SVGR converter](https://react-svgr.com/playground/).
|
|
1. Paste your SVG code into the SVG input field.
|
|
2. Copy the complete `<svg>...</svg>` element from the JSX output field.
|
|
3. Wrap the JSX-compatible SVG code in curly braces: `icon={<svg ...> ... </svg>}`.
|
|
4. Adjust `height` and `width` as needed.
|
|
</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> |