Open
Conversation
Encode each icon's SVG as a base64 data URI in the @Preview JSDoc tag, enabling IDE hover previews for all icon components. JSDoc is added to both the individual icon files and the barrel re-exports so that rollup-plugin-dts preserves them in the bundled .d.ts output. Co-authored-by: Cursor <[email protected]>
|
@theopak is attempting to deploy a commit to the Tabler Team on Vercel. A member of the Team first needs to authorize it. |
|
✅ All icons are valid! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds JSDoc annotations to the icons-react package so that people using it can see a preview of the icon, and links to the documentation, by hovering over the icon component in supported IDEs like VSCode.
I added this for my own convenience and just wanted to share. I got the idea from a different icon library that uses this same technique: lucide-icons/lucide#1424
AI Disclosure: This change was implemented with AI assistance (Claude Opus 4.6, Cursor Tab) and reviewed by me.