docs: document relative SVG path support for Card and Icon components #2910
Conversation
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -0,0 +1,16 @@ | |||
| ## Custom SVG icons in Card and Icon components | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Custom SVG icons in Card and Icon components' should use sentence-style capitalization.
| @@ -0,0 +1,16 @@ | |||
| ## Custom SVG icons in Card and Icon components | |||
|
|
|||
| The Card and Icon components now support relative paths to SVG files. Use a relative path like `./images/icon.svg` to display custom SVG icons from your project. | |||
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| <Icon icon="fa-brands fa-github" /> Brands | ||
| ``` | ||
|
|
||
| ### Custom SVG |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Custom SVG' should use sentence-style capitalization.
| <Icon icon="fa-brands fa-github" /> Brands | ||
| ``` | ||
|
|
||
| ### Custom SVG icon |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Custom SVG icon' should use sentence-style capitalization.
Summary
Documents that the Card and Icon components support relative paths to SVG files (e.g.,
./images/icon.svg). Changes include:iconproperty descriptions in both components to mention relative SVG pathsUpdates since last revision
Review & Testing Checklist for Human
icon="./images/example.svg"actually renders an SVG in both Card and Icon components - I documented this based on the request but did not test the actual functionality/learn/docs/writing-content/components/cardsand/learn/docs/writing-content/components/iconsresolve correctlyRecommended test plan: Create a test SVG file and try using it with both
<Card icon="./path/to/test.svg">and<Icon icon="./path/to/test.svg" />to confirm the documented syntax is correct.Notes