-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
docs: update Icon documentation to reflect modular icon packages #4009
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update Icon documentation to reflect modular icon packages #4009
Conversation
…usage instructions
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #4009 +/- ##
=======================================
Coverage 79.26% 79.26%
=======================================
Files 90 90
Lines 2141 2141
Branches 957 960 +3
=======================================
Hits 1697 1697
Misses 442 442
Partials 2 2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the Icon component documentation to reflect the migration from the monolithic react-native-vector-icons library to modular icon packages. The changes improve documentation clarity by listing individual package names for each icon set and updating the code example.
Key Changes:
- Added comprehensive package installation information for each icon set with corresponding npm package names
- Updated icon usage example by changing Ionicons icon name from 'ios-american-football' to 'american-football'
- Added font-awesome-6 to the list of available icon sets
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| The icon sets in React Native Elements are now powered by modular icon packages from | ||
| [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons). | ||
| The original `react-native-vector-icons` library has been deprecated, and we now use individual packages for each icon set to reduce bundle size and improve performance. |
Copilot
AI
Dec 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The statement "The original react-native-vector-icons library has been deprecated" is inaccurate. Based on the code in packages/base/src/helpers/getIconType.tsx, the library supports both the new modular packages and the original react-native-vector-icons library as a fallback. The code shows warning messages when the old library is used, but it's not deprecated - it's still supported for backward compatibility. Consider revising to: "We now use individual packages for each icon set to reduce bundle size and improve performance, while maintaining backward compatibility with the original library."
| The original `react-native-vector-icons` library has been deprecated, and we now use individual packages for each icon set to reduce bundle size and improve performance. | |
| We now use individual packages for each icon set to reduce bundle size and improve performance, while maintaining backward compatibility with the original library. |
theianmay
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good - merged!
Added missing documentation for modular icons lib docs.
Continue from Icons library upgrade PR #3994
Fixes # (issue)
Type of change
How Has This Been Tested?
exampleappChecklist
yarn docs-build-apiAdditional context