Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

feat(icons): rename checkCircle/xCircle to success/error (#1503)

Cindy Zhang11d6933276cc
diff --git a/apps/storybook/stories/XDSMediaTheme.stories.tsx b/apps/storybook/stories/XDSMediaTheme.stories.tsx
index e817b8c413..c1fe066235 100644
--- a/apps/storybook/stories/XDSMediaTheme.stories.tsx
+++ b/apps/storybook/stories/XDSMediaTheme.stories.tsx
@@ -61,7 +61,7 @@ function OnDarkDemo() {
<XDSStack direction="row" gap={2} align="center" wrap="wrap">
<XDSBadge label="Badge" />
<XDSIcon icon="info" size="md" />
- <XDSIcon icon="checkCircle" size="md" />
+ <XDSIcon icon="success" size="md" />
</XDSStack>
</XDSStack>
</XDSMediaTheme>
diff --git a/packages/cli/src/codemods/transforms/v0.0.14/icon-name-deprecations.mjs b/packages/cli/src/codemods/transforms/v0.0.14/icon-name-deprecations.mjs
new file mode 100644
index 0000000000..944c092cbc
--- /dev/null
+++ b/packages/cli/src/codemods/transforms/v0.0.14/icon-name-deprecations.mjs
@@ -0,0 +1,95 @@
+/**
+ * @file Codemod: Rename icon names to preferred names
+ *
+ * Renames:
+ * - "checkCircle" → "success"
+ * - "xCircle" → "error"
+ *
+ * Handles:
+ * - JSX string literals: icon="checkCircle" → icon="success"
+ * - Object properties: { icon: "checkCircle" } → { icon: "success" }
+ * - String assignments: const x = "checkCircle" (when assigned to icon-typed vars)
+ * - Icon registry objects: { checkCircle: <Svg /> } → { success: <Svg /> }
+ */
+
+export const meta = {
+ title: 'Rename icon names (checkCircle → success, xCircle → error)',
+ description:
+ 'Replaces "checkCircle" and "xCircle" with ' +
+ 'their preferred equivalents "success" and "error".',
+ pr: '#1503',
+};
+
+const RENAMES = {
+ checkCircle: 'success',
+ xCircle: 'error',
+};
+
+/** Prop names that accept XDSIconName values */
+const ICON_PROPS = new Set(['icon', 'name', 'selectedIcon']);
+
+export default function transformer(file, api) {
+ const j = api.jscodeshift;
+ const root = j(file.source);
+ let hasChanges = false;
+
+ // 1. JSX attributes: icon="checkCircle" → icon="success"
+ root.find(j.JSXAttribute).forEach((path) => {
+ const attrName = path.node.name?.name;
+ if (!ICON_PROPS.has(attrName)) return;
+
+ const value = path.node.value;
+ if (value && (value.type === 'StringLiteral' || value.type === 'Literal')) {
+ const newName = RENAMES[value.value];
+ if (newName) {
+ path.node.value = j.stringLiteral(newName);
+ hasChanges = true;
+ }
+ }
+ });
+
+ // 2. Object properties in icon maps: { checkCircle: <Svg /> }
+ // Only when the key matches a deprecated name AND the file looks like an icon registry
+ const looksLikeIconRegistry =
+ file.source.includes('XDSIconRegistry') ||
+ file.source.includes('iconRegistry') ||
+ file.source.includes('IconRegistry');
+
+ if (looksLikeIconRegistry) {
+ const PropertyType = j.ObjectProperty ?? j.Property;
+ root.find(PropertyType).forEach((path) => {
+ const key = path.node.key;
+ if (!key) return;
+ const keyName =
+ key.type === 'Identifier' ? key.name :
+ (key.type === 'StringLiteral' || key.type === 'Literal') ? key.value :
+ null;
+ const newName = keyName && RENAMES[keyName];
+ if (newName) {
+ path.node.key = j.identifier(newName);
+ hasChanges = true;
+ }
+ });
+ }
+
+ // 3. String literals in objects with icon-related keys
+ // e.g. { label: "TestX", href: "/pages/testx", icon: "checkCircle" }
+ const PropertyType2 = j.ObjectProperty ?? j.Property;
+ root.find(PropertyType2).forEach((path) => {
+ const key = path.node.key;
+ const keyName = key?.type === 'Identifier' ? key.name : key?.value;
+ if (!ICON_PROPS.has(keyName)) return;
+
+ const value = path.node.value;
+ if (value && (value.type === 'StringLiteral' || value.type === 'Literal')) {
+ const newName = RENAMES[value.value];
+ if (newName) {
+ path.node.value = j.stringLiteral(newName);
+ hasChanges = true;
+ }
+ }
+ });
+
+ if (!hasChanges) return undefined;
+ return root.toSource({quote: 'single'});
+}
diff --git a/packages/cli/src/codemods/transforms/v0.0.14/index.mjs b/packages/cli/src/codemods/transforms/v0.0.14/index.mjs
index 8a21187370..769ec08cca 100644
--- a/packages/cli/src/codemods/transforms/v0.0.14/index.mjs
+++ b/packages/cli/src/codemods/transforms/v0.0.14/index.mjs
@@ -8,10 +8,19 @@ import toolbarDensityToSize, {
meta as toolbarDensityToSizeMeta,
} from './toolbar-density-to-size.mjs';
+import iconNameDeprecations, {
+ meta as iconNameDeprecationsMeta,
+} from './icon-name-deprecations.mjs';
+
export default [
{
name: 'toolbar-density-to-size',
transform: toolbarDensityToSize,
meta: toolbarDensityToSizeMeta,
},
+ {
+ name: 'icon-name-deprecations',
+ transform: iconNameDeprecations,
+ meta: iconNameDeprecationsMeta,
+ },
];
diff --git a/packages/cli/templates/blocks/components/Icon/IconSemanticNames.tsx b/packages/cli/templates/blocks/components/Icon/IconSemanticNames.tsx
index c29c3bc16c..1a0074c63b 100644
--- a/packages/cli/templates/blocks/components/Icon/IconSemanticNames.tsx
+++ b/packages/cli/templates/blocks/components/Icon/IconSemanticNames.tsx
@@ -7,7 +7,7 @@ export default function IconSemanticNames() {
<div style={{display: 'flex', gap: 16, alignItems: 'center'}}>
<XDSIcon icon="close" />
<XDSIcon icon="chevronDown" size="sm" color="inherit" />
- <XDSIcon icon="checkCircle" color="positive" />
+ <XDSIcon icon="success" color="positive" />
<XDSIcon icon="info" size="sm" color="secondary" />
</div>
);
diff --git a/packages/core/src/Banner/XDSBanner.tsx b/packages/core/src/Banner/XDSBanner.tsx
index 4464331bee..d6cd0d5974 100644
--- a/packages/core/src/Banner/XDSBanner.tsx
+++ b/packages/core/src/Banner/XDSBanner.tsx
@@ -185,8 +185,8 @@ export interface XDSBannerProps {
const defaultIconNames: Record<XDSBannerStatus, XDSIconName> = {
info: 'info',
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
// =============================================================================
diff --git a/packages/core/src/Chat/XDSChatComposer.tsx b/packages/core/src/Chat/XDSChatComposer.tsx
index c04de343f3..5dab081986 100644
--- a/packages/core/src/Chat/XDSChatComposer.tsx
+++ b/packages/core/src/Chat/XDSChatComposer.tsx
@@ -217,13 +217,15 @@ const styles = stylex.create({
},
statusTop: {
paddingBlockStart: 'var(--_chat-composer-padding)',
- paddingBlockEnd: 'calc(var(--_chat-composer-padding) + var(--_chat-composer-radius))',
+ paddingBlockEnd:
+ 'calc(var(--_chat-composer-padding) + var(--_chat-composer-radius))',
marginBlockEnd: 'calc(-1 * var(--_chat-composer-radius))',
borderTopLeftRadius: 'var(--_chat-composer-radius)',
borderTopRightRadius: 'var(--_chat-composer-radius)',
},
statusBottom: {
- paddingBlockStart: 'calc(var(--_chat-composer-padding) + var(--_chat-composer-radius))',
+ paddingBlockStart:
+ 'calc(var(--_chat-composer-padding) + var(--_chat-composer-radius))',
paddingBlockEnd: 'var(--_chat-composer-padding)',
marginBlockStart: 'calc(-1 * var(--_chat-composer-radius))',
borderBottomLeftRadius: 'var(--_chat-composer-radius)',
@@ -325,7 +327,7 @@ export function XDSChatComposer(props: XDSChatComposerProps) {
status.type === 'warning' && styles.statusWarning,
)}>
<XDSIcon
- icon={status.type === 'error' ? 'xCircle' : 'warning'}
+ icon={status.type === 'error' ? 'error' : 'warning'}
size="md"
color={status.type === 'error' ? 'negative' : 'warning'}
/>
diff --git a/packages/core/src/Chat/XDSChatMessageMetadata.tsx b/packages/core/src/Chat/XDSChatMessageMetadata.tsx
index 4d73160352..633c0e42b7 100644
--- a/packages/core/src/Chat/XDSChatMessageMetadata.tsx
+++ b/packages/core/src/Chat/XDSChatMessageMetadata.tsx
@@ -38,7 +38,7 @@ const STATUS_CONFIG: Record<
sent: {icon: 'check', label: 'Sent'},
delivered: {icon: 'checkDouble', label: 'Delivered'},
read: {icon: 'checkDouble', label: 'Read'},
- error: {icon: 'xCircle', label: 'Failed'},
+ error: {icon: 'error', label: 'Failed'},
};
const pulseKeyframes = stylex.keyframes({
diff --git a/packages/core/src/DateInput/XDSDateInput.tsx b/packages/core/src/DateInput/XDSDateInput.tsx
index 29afe35019..5efd947d99 100644
--- a/packages/core/src/DateInput/XDSDateInput.tsx
+++ b/packages/core/src/DateInput/XDSDateInput.tsx
@@ -294,8 +294,8 @@ export function XDSDateInput({
// Status icon mapping
const statusIconMap: Record<XDSInputStatusType, XDSIconName> = {
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
const statusIconColorMap: Record<
diff --git a/packages/core/src/Icon/defaultIcons.tsx b/packages/core/src/Icon/defaultIcons.tsx
index 0d7069ec5f..8a62f709a6 100644
--- a/packages/core/src/Icon/defaultIcons.tsx
+++ b/packages/core/src/Icon/defaultIcons.tsx
@@ -87,8 +87,8 @@ export const defaultIcons: XDSIconRegistry = {
</svg>
),
- /** ✓ in circle — success (solid fill for status visibility) */
- checkCircle: (
+ /** ✓ in circle — success state (solid fill for status visibility) */
+ success: (
<svg {...solidSvgProps}>
<path
fillRule="evenodd"
@@ -98,8 +98,8 @@ export const defaultIcons: XDSIconRegistry = {
</svg>
),
- /** ✕ in circle — error (solid fill for status visibility) */
- xCircle: (
+ /** ✕ in circle — error state (solid fill for status visibility) */
+ error: (
<svg {...solidSvgProps}>
<path
fillRule="evenodd"
@@ -257,6 +257,4 @@ export const defaultIcons: XDSIconRegistry = {
<path d="M12 18v4m-4 0h8" />
</svg>
),
-
- /** ⏺ — filled circle (recording indicator) */
};
diff --git a/packages/core/src/Icon/globalIconRegistry.tsx b/packages/core/src/Icon/globalIconRegistry.tsx
index 3a0e0af843..c9dee6b4e2 100644
--- a/packages/core/src/Icon/globalIconRegistry.tsx
+++ b/packages/core/src/Icon/globalIconRegistry.tsx
@@ -28,8 +28,8 @@ export type XDSIconName =
| 'chevronLeft'
| 'chevronRight'
| 'check'
- | 'checkCircle'
- | 'xCircle'
+ | 'success'
+ | 'error'
| 'warning'
| 'info'
| 'calendar'
diff --git a/packages/core/src/MultiSelector/XDSMultiSelector.tsx b/packages/core/src/MultiSelector/XDSMultiSelector.tsx
index b2abc6b071..fb89827dad 100644
--- a/packages/core/src/MultiSelector/XDSMultiSelector.tsx
+++ b/packages/core/src/MultiSelector/XDSMultiSelector.tsx
@@ -332,8 +332,8 @@ const selectAllSizeStyles = stylex.create({
const STATUS_ICON_MAP: Record<XDSMultiSelectorStatusType, XDSIconName> = {
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
const STATUS_ICON_COLOR_MAP: Record<
diff --git a/packages/core/src/NumberInput/XDSNumberInput.tsx b/packages/core/src/NumberInput/XDSNumberInput.tsx
index 19577f399c..681a6655ed 100644
--- a/packages/core/src/NumberInput/XDSNumberInput.tsx
+++ b/packages/core/src/NumberInput/XDSNumberInput.tsx
@@ -368,8 +368,8 @@ export function XDSNumberInput({
const statusIconMap: Record<XDSInputStatusType, XDSIconName> = {
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
const statusIconColorMap: Record<
diff --git a/packages/core/src/Selector/XDSSelector.tsx b/packages/core/src/Selector/XDSSelector.tsx
index 752c3d5cde..98d08874ce 100644
--- a/packages/core/src/Selector/XDSSelector.tsx
+++ b/packages/core/src/Selector/XDSSelector.tsx
@@ -264,8 +264,8 @@ const itemSizeStyles = stylex.create({
const STATUS_ICON_MAP: Record<XDSSelectorStatusType, XDSIconName> = {
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
const STATUS_ICON_COLOR_MAP: Record<
diff --git a/packages/core/src/TextArea/XDSTextArea.tsx b/packages/core/src/TextArea/XDSTextArea.tsx
index 773b9b37b1..113e2dbacc 100644
--- a/packages/core/src/TextArea/XDSTextArea.tsx
+++ b/packages/core/src/TextArea/XDSTextArea.tsx
@@ -298,8 +298,8 @@ export function XDSTextArea({
const statusIconMap: Record<XDSTextAreaStatusType, XDSIconName> = {
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
const statusIconColorMap: Record<
diff --git a/packages/core/src/TextInput/XDSTextInput.tsx b/packages/core/src/TextInput/XDSTextInput.tsx
index 3b05c9f24b..d69b91c772 100644
--- a/packages/core/src/TextInput/XDSTextInput.tsx
+++ b/packages/core/src/TextInput/XDSTextInput.tsx
@@ -272,8 +272,8 @@ export function XDSTextInput({
const statusIconMap: Record<XDSInputStatusType, XDSIconName> = {
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
const statusIconColorMap: Record<
diff --git a/packages/core/src/TimeInput/XDSTimeInput.tsx b/packages/core/src/TimeInput/XDSTimeInput.tsx
index 81ea36ac67..f1c8ce7832 100644
--- a/packages/core/src/TimeInput/XDSTimeInput.tsx
+++ b/packages/core/src/TimeInput/XDSTimeInput.tsx
@@ -336,8 +336,8 @@ export function XDSTimeInput({
// Status icon mapping
const statusIconMap: Record<XDSInputStatusType, XDSIconName> = {
warning: 'warning',
- error: 'xCircle',
- success: 'checkCircle',
+ error: 'error',
+ success: 'success',
};
const statusIconColorMap: Record<
diff --git a/packages/themes/daily/src/icons.tsx b/packages/themes/daily/src/icons.tsx
index 45e83e2db8..8f3306dfa5 100644
--- a/packages/themes/daily/src/icons.tsx
+++ b/packages/themes/daily/src/icons.tsx
@@ -42,8 +42,8 @@ export const dailyIconRegistry: XDSIconRegistry = {
chevronLeft: <ChevronLeft {...iconProps} />,
chevronRight: <ChevronRight {...iconProps} />,
check: <Check {...iconProps} />,
- checkCircle: <CheckCircle {...iconProps} />,
- xCircle: <XCircle {...iconProps} />,
+ success: <CheckCircle {...iconProps} />,
+ error: <XCircle {...iconProps} />,
warning: <AlertTriangle {...iconProps} />,
info: <Info {...iconProps} />,
calendar: <Calendar {...iconProps} />,
diff --git a/packages/themes/default/src/icons.tsx b/packages/themes/default/src/icons.tsx
index 1ed6d66fba..b510ddb8dd 100644
--- a/packages/themes/default/src/icons.tsx
+++ b/packages/themes/default/src/icons.tsx
@@ -55,8 +55,8 @@ export const defaultIconRegistry: XDSIconRegistry = {
chevronLeft: <ChevronLeftIcon {...iconProps} />,
chevronRight: <ChevronRightIcon {...iconProps} />,
check: <CheckIcon {...iconProps} />,
- checkCircle: <CheckCircleIcon {...iconProps} />,
- xCircle: <XCircleIcon {...iconProps} />,
+ success: <CheckCircleIcon {...iconProps} />,
+ error: <XCircleIcon {...iconProps} />,
warning: <ExclamationTriangleIcon {...iconProps} />,
info: <InformationCircleIcon {...iconProps} />,
calendar: <CalendarDaysIcon {...iconProps} />,
diff --git a/packages/themes/meta/src/icons.tsx b/packages/themes/meta/src/icons.tsx
index 94f7ec1000..2a8bc672c4 100644
--- a/packages/themes/meta/src/icons.tsx
+++ b/packages/themes/meta/src/icons.tsx
@@ -53,8 +53,8 @@ export const metaIconRegistry: XDSIconRegistry = {
chevronLeft: <ChevronLeftIcon {...iconProps} />,
chevronRight: <ChevronRightIcon {...iconProps} />,
check: <CheckIcon {...iconProps} />,
- checkCircle: <CheckCircleIcon {...iconProps} />,
- xCircle: <XCircleIcon {...iconProps} />,
+ success: <CheckCircleIcon {...iconProps} />,
+ error: <XCircleIcon {...iconProps} />,
warning: <ExclamationTriangleIcon {...iconProps} />,
info: <InformationCircleIcon {...iconProps} />,
calendar: <CalendarDaysIcon {...iconProps} />,
diff --git a/packages/themes/neutral/src/icons.tsx b/packages/themes/neutral/src/icons.tsx
index 5a4be827e0..f140d7cba0 100644
--- a/packages/themes/neutral/src/icons.tsx
+++ b/packages/themes/neutral/src/icons.tsx
@@ -52,8 +52,8 @@ export const neutralIconRegistry: XDSIconRegistry = {
chevronLeft: <ChevronLeft {...iconProps} />,
chevronRight: <ChevronRight {...iconProps} />,
check: <Check {...iconProps} />,
- checkCircle: <CheckCircle {...iconProps} />,
- xCircle: <XCircle {...iconProps} />,
+ success: <CheckCircle {...iconProps} />,
+ error: <XCircle {...iconProps} />,
warning: <AlertTriangle {...iconProps} />,
info: <Info {...iconProps} />,
calendar: <Calendar {...iconProps} />,
diff --git a/packages/themes/whatsapp/src/icons.tsx b/packages/themes/whatsapp/src/icons.tsx
index f01d5b5ae7..4ce41874c5 100644
--- a/packages/themes/whatsapp/src/icons.tsx
+++ b/packages/themes/whatsapp/src/icons.tsx
@@ -53,8 +53,8 @@ export const whatsappIconRegistry: XDSIconRegistry = {
chevronLeft: <ChevronLeftIcon {...iconProps} />,
chevronRight: <ChevronRightIcon {...iconProps} />,
check: <CheckIcon {...iconProps} />,
- checkCircle: <CheckCircleIcon {...iconProps} />,
- xCircle: <XCircleIcon {...iconProps} />,
+ success: <CheckCircleIcon {...iconProps} />,
+ error: <XCircleIcon {...iconProps} />,
warning: <ExclamationTriangleIcon {...iconProps} />,
info: <InformationCircleIcon {...iconProps} />,
calendar: <CalendarDaysIcon {...iconProps} />,