Skip to content

docs(docsite-v9): clarify brand-background demo in ColorAndAppearance story #36570

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
Martin Hochel (Hotell) merged 2 commits into from
Aug 25, 2026
+33 −11
Merged

docs(docsite-v9): clarify brand-background demo in ColorAndAppearance story #36570

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d09e34
Initial plan
Copilot Aug 13, 2026
77f1552
docs(react-badge): clarify brand-background demo in ColorAndAppearanc…
Copilot Aug 13, 2026
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
44 changes: 33 additions & 11 deletions packages/react-components/react-badge/stories/src/Badge/BadgeColorVsAppearance.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,23 @@ const useStyles = makeStyles({
},
badge: {
display: 'flex',
alignItems: 'center',
gap: tokens.spacingHorizontalS,
},
brand: {
display: 'flex',
alignItems: 'center',
gap: tokens.spacingHorizontalS,
backgroundColor: tokens.colorBrandBackground,
padding: tokens.spacingHorizontalXXS,
padding: `${tokens.spacingVerticalS} ${tokens.spacingHorizontalM}`,
borderRadius: tokens.borderRadiusMedium,
},
brandLabel: {
color: tokens.colorNeutralForegroundOnBrand,
fontFamily: tokens.fontFamilyBase,
fontSize: tokens.fontSizeBase200,
lineHeight: tokens.lineHeightBase200,
fontWeight: tokens.fontWeightSemibold,
},
});

Expand All @@ -36,20 +47,29 @@ const Badges = (props: BadgeProps) => {
'warning',
];

const isSubtleOnBrandOnly = appearance === 'ghost' || appearance === 'outline';

return (
<div className={styles.badge}>
{colors.map(color => {
const BadgeWrapper =
color === 'subtle' && (appearance === 'ghost' || appearance === 'outline')
? ({ children }: { children: React.ReactNode }) => <div className={styles.brand}>{children}</div>
: React.Fragment;
// `ghost-subtle` and `outline-subtle` are only meant to be used on a branded background,
// so they are rendered within an explicit "brand surface" demo container instead of the
// ambient story background.
if (color === 'subtle' && isSubtleOnBrandOnly) {
return (
<div key={`${appearance}-${color}`} className={styles.brand}>
<span className={styles.brandLabel}>On brand background:</span>
<Badge appearance={appearance} color={color} icon={<PasteIcon />}>
999+
</Badge>
</div>
);
}

return (
<BadgeWrapper key={`${appearance}-${color}`}>
<Badge appearance={appearance} color={color} icon={<PasteIcon />}>
999+
</Badge>
</BadgeWrapper>
<Badge key={`${appearance}-${color}`} appearance={appearance} color={color} icon={<PasteIcon />}>
999+
</Badge>
);
})}
</div>
Expand All @@ -76,7 +96,9 @@ export const ColorAndAppearance = (): JSXElement => {
ColorAndAppearance.parameters = {
docs: {
description: {
story: 'Note: `ghost-subtle` and `outline-subtle` are intended only for use on brand background.',
story:
'`ghost-subtle` and `outline-subtle` are intended only for use on a branded background — ' +
'the boxed "On brand background:" examples above demonstrate the intended usage context.',
},
},
};
Loading