[Docs] Update Text component docs: Add warning about nesting Icon/Badge #3660
+3
−0
Conversation
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
cappslock
approved these changes
Dec 16, 2025
- Add best practice: Use Stack for icons and badges instead of nesting - Add limitation: Explain React Native alignment issue with nested Icon/Badge - Provide Stack with direction='inline' as recommended alternative Addresses #21094
armaan-ghosh
force-pushed
the
ag/text-icon-badge-docs-warning
branch
from
f40a60b to
fbeefc2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Background
Issue: #21094
Developers have been intuitively nesting
<s-icon>and<s-badge>components inside<s-text>, expecting them to align with the text baseline. However, this causes visible vertical misalignment (originally reported in #19011).Root cause: React Native's
Textcomponent fundamentally does not support baseline alignment for nestedViewcomponents. SinceIconrenders as an SVGViewandBadgerenders asHStack→Box→Badge, they float without proper vertical positioning when nested insideText.Solution
Updated the Text component documentation to prevent this common mistake by:
Best Practices section - Added guidance to use
Stackwithdirection="inline"when combining text with icons or badges, rather than nesting components insideTextLimitations section - Added clear explanation of the React Native alignment limitation with nested
Icon/Badgecomponents, including the recommendedStackalternative patternThis is a documentation-only change that guides developers toward the correct pattern without requiring code changes or impacting performance.