Skip to content

Conversation

@deepktp
Copy link
Contributor

@deepktp deepktp commented Dec 4, 2025

Added missing documentation for modular icons lib docs.

Continue from Icons library upgrade PR #3994

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • Jest Unit Test
  • Checked with example app

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation using yarn docs-build-api
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Additional context

@deepktp deepktp marked this pull request as ready for review December 4, 2025 19:54
Copilot AI review requested due to automatic review settings December 4, 2025 19:54
@codecov
Copy link

codecov bot commented Dec 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.26%. Comparing base (6fedc3f) to head (98bff52).
⚠️ Report is 3 commits behind head on next.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot finished reviewing on behalf of deepktp December 4, 2025 19:57
Copy link
Contributor

Copilot AI left a 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.
Copy link

Copilot AI Dec 4, 2025

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."

Suggested change
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.

Copilot uses AI. Check for mistakes.
@theianmay theianmay self-assigned this Dec 4, 2025
@theianmay theianmay added component: Icon Issue related to Icon Component PR: Docs 📝 labels Dec 4, 2025
@theianmay theianmay added this to the v5.0.0 milestone Dec 4, 2025
@github-project-automation github-project-automation bot moved this to In Progress 🚧 in Community Roadmap 🛣 Dec 4, 2025
@theianmay theianmay merged commit 8a40af6 into react-native-elements:next Dec 4, 2025
15 checks passed
@github-project-automation github-project-automation bot moved this from In Progress 🚧 to Closed or Merged 🏁 in Community Roadmap 🛣 Dec 4, 2025
@theianmay theianmay self-requested a review December 5, 2025 06:38
Copy link
Member

@theianmay theianmay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - merged!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: Icon Issue related to Icon Component PR: Docs 📝

Projects

Status: Closed or Merged 🏁

Development

Successfully merging this pull request may close these issues.

2 participants