Skip to content

[Docs] Update Text component docs: Add warning about nesting Icon/Badge #3660

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.

Sign up for GitHub

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

Merged
cappslock merged 1 commit into from
Dec 17, 2025
+3 −0
Merged

[Docs] Update Text component docs: Add warning about nesting Icon/Badge #3660

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/ui-extensions/src/surfaces/point-of-sale/components/Text/Text.doc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ const data: ReferenceEntityTemplateSchema = {
- **Apply appropriate tones:** Use \`success\` for positive outcomes, \`warning\` or \`critical\` for alerts, \`info\` for helpful context, \`auto\` for neutral content.
- **Balance color intensity:** Use \`strong\` for emphasis, \`base\` for readability, \`subdued\` for secondary info.
- **Nest for mixed formatting:** Nest \`Text\` components when you need multiple styles within one text block.
- **Use Stack for icons and badges:** When combining text with icons or badges, use Stack with direction="inline" instead of nesting components inside Text.
`,
},
{
Expand All @@ -50,6 +51,8 @@ const data: ReferenceEntityTemplateSchema = {
title: 'Limitations',
sectionContent: `
Complex rich text formatting isn't supported—use multiple \`Text\` components or nested text elements for varied formatting needs.
Nesting Icon or Badge components inside Text isn't supported due to React Native alignment limitations—use Stack with direction="inline" and alignItems="center" instead to properly align icons and badges with text.
`,
},
],
Expand Down