You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Document the new optional src prop on the <Icon> component for using custom image files or external image URLs as icons.
Changes
Add a new srcResponseField and an Either icon or src must be provided notice to the shared icons-required snippet (en, es, fr, zh).
Make the icon prop no longer required, and scope its options to icon-library names.
Add a "Custom image icons" section with examples on components/icons.mdx and its es/fr/zh translations.
Context
Follows up on mintlify/mint#8190, which made icon optional and added a src prop that accepts a path to a local image or a URL to an externally hosted image.
Note
Low Risk
Documentation-only updates to MDX snippets and translated pages; no runtime or API behavior changes in this repo.
Overview
Documents the <Icon> component’s optional src prop for custom images (local paths or external URLs), aligned with the product change in mint#8190.
The shared icons-required snippets (en, es, fr, zh) now state that icon or src is required, drop required on icon, limit icon to library names, and add a dedicated src field. components/icons.mdx and es/fr/zh translations add a Custom image icons section with MDX examples.
Reviewed by Cursor Bugbot for commit f4aefd4. Bugbot is set up for automated code reviews on this repo. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the new optional
srcprop on the<Icon>component for using custom image files or external image URLs as icons.Changes
srcResponseFieldand anEither icon or src must be providednotice to the sharedicons-requiredsnippet (en, es, fr, zh).iconprop no longer required, and scope its options to icon-library names.components/icons.mdxand its es/fr/zh translations.Context
Follows up on mintlify/mint#8190, which made
iconoptional and added asrcprop that accepts a path to a local image or a URL to an externally hosted image.Note
Low Risk
Documentation-only updates to MDX snippets and translated pages; no runtime or API behavior changes in this repo.
Overview
Documents the
<Icon>component’s optionalsrcprop for custom images (local paths or external URLs), aligned with the product change in mint#8190.The shared
icons-requiredsnippets (en, es, fr, zh) now state thaticonorsrcis required, droprequiredonicon, limiticonto library names, and add a dedicatedsrcfield.components/icons.mdxand es/fr/zh translations add a Custom image icons section with MDX examples.Reviewed by Cursor Bugbot for commit f4aefd4. Bugbot is set up for automated code reviews on this repo. Configure here.