Skip to content

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

TypeScript

test(core): replace @heroicons phantom dep with a local SVG fixture (#3746)

Cindy Zhang575d8bfd2cb9
diff --git a/packages/core/src/Field/FieldLabel.test.tsx b/packages/core/src/Field/FieldLabel.test.tsx
index 3f98c723cc..e7db702172 100644
--- a/packages/core/src/Field/FieldLabel.test.tsx
+++ b/packages/core/src/Field/FieldLabel.test.tsx
@@ -11,7 +11,7 @@
import {describe, it, expect, vi} from 'vitest';
import {render, screen} from '@testing-library/react';
-import {StarIcon} from '@heroicons/react/24/outline';
+import {TestIcon} from '../__tests__/TestIcon';
import {FieldLabel} from './FieldLabel';
describe('FieldLabel', () => {
@@ -49,7 +49,7 @@ describe('FieldLabel', () => {
<FieldLabel
label="Starred"
inputID="starred-input"
- labelIcon={StarIcon}
+ labelIcon={TestIcon}
/>,
);
const svg = document.querySelector('svg');
diff --git a/packages/core/src/Icon/Icon.test.tsx b/packages/core/src/Icon/Icon.test.tsx
index 6ae1ddff54..6e04a332b1 100644
--- a/packages/core/src/Icon/Icon.test.tsx
+++ b/packages/core/src/Icon/Icon.test.tsx
@@ -11,48 +11,48 @@
import {describe, it, expect, vi} from 'vitest';
import {render, screen} from '@testing-library/react';
-import {HomeIcon} from '@heroicons/react/24/outline';
+import {TestIcon} from '../__tests__/TestIcon';
import {Icon} from './Icon';
describe('Icon', () => {
it('renders the icon component', () => {
- render(<Icon icon={HomeIcon} data-testid="icon" />);
+ render(<Icon icon={TestIcon} data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
});
it('renders as an SVG element', () => {
- render(<Icon icon={HomeIcon} data-testid="icon" />);
+ render(<Icon icon={TestIcon} data-testid="icon" />);
const icon = screen.getByTestId('icon');
expect(icon.tagName.toLowerCase()).toBe('svg');
});
it('applies aria-hidden by default', () => {
- render(<Icon icon={HomeIcon} data-testid="icon" />);
+ render(<Icon icon={TestIcon} data-testid="icon" />);
expect(screen.getByTestId('icon')).toHaveAttribute('aria-hidden', 'true');
});
it('renders with different color variants', () => {
const {rerender} = render(
- <Icon icon={HomeIcon} color="primary" data-testid="icon" />,
+ <Icon icon={TestIcon} color="primary" data-testid="icon" />,
);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} color="secondary" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} color="secondary" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} color="accent" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} color="accent" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} color="success" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} color="success" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} color="error" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} color="error" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} color="warning" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} color="warning" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} color="inherit" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} color="inherit" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
});
@@ -70,41 +70,41 @@ describe('Icon', () => {
'purple',
] as const;
const {rerender} = render(
- <Icon icon={HomeIcon} color={nonSemanticColors[0]} data-testid="icon" />,
+ <Icon icon={TestIcon} color={nonSemanticColors[0]} data-testid="icon" />,
);
expect(screen.getByTestId('icon')).toBeInTheDocument();
for (const c of nonSemanticColors.slice(1)) {
- rerender(<Icon icon={HomeIcon} color={c} data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} color={c} data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
}
});
it('renders with different size variants', () => {
const {rerender} = render(
- <Icon icon={HomeIcon} size="xsm" data-testid="icon" />,
+ <Icon icon={TestIcon} size="xsm" data-testid="icon" />,
);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} size="sm" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} size="sm" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} size="md" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} size="md" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
- rerender(<Icon icon={HomeIcon} size="lg" data-testid="icon" />);
+ rerender(<Icon icon={TestIcon} size="lg" data-testid="icon" />);
expect(screen.getByTestId('icon')).toBeInTheDocument();
});
it('forwards ref correctly', () => {
const ref = vi.fn();
- render(<Icon icon={HomeIcon} ref={ref} />);
+ render(<Icon icon={TestIcon} ref={ref} />);
expect(ref).toHaveBeenCalledWith(expect.any(SVGSVGElement));
});
it('passes additional SVG props', () => {
render(
- <Icon icon={HomeIcon} data-testid="icon" role="img" aria-label="Home" />,
+ <Icon icon={TestIcon} data-testid="icon" role="img" aria-label="Home" />,
);
const icon = screen.getByTestId('icon');
expect(icon).toHaveAttribute('role', 'img');
@@ -112,7 +112,7 @@ describe('Icon', () => {
});
it('uses default color and size when not specified', () => {
- render(<Icon icon={HomeIcon} data-testid="icon" />);
+ render(<Icon icon={TestIcon} data-testid="icon" />);
// The component should render without errors with defaults
expect(screen.getByTestId('icon')).toBeInTheDocument();
});
diff --git a/packages/core/src/NumberInput/NumberInput.test.tsx b/packages/core/src/NumberInput/NumberInput.test.tsx
index 617d806d18..310aa2a5de 100644
--- a/packages/core/src/NumberInput/NumberInput.test.tsx
+++ b/packages/core/src/NumberInput/NumberInput.test.tsx
@@ -12,7 +12,7 @@
import {describe, it, expect, vi, beforeEach} from 'vitest';
import {render, screen, fireEvent, waitFor} from '@testing-library/react';
import userEvent from '@testing-library/user-event';
-import {HashtagIcon} from '@heroicons/react/24/outline';
+import {TestIcon} from '../__tests__/TestIcon';
import {NumberInput} from './NumberInput';
// Mock showPopover/hidePopover since jsdom does not implement them. Used by the
@@ -174,7 +174,7 @@ describe('NumberInput', () => {
label="Count"
value={null}
onChange={() => {}}
- startIcon={HashtagIcon}
+ startIcon={TestIcon}
/>,
);
expect(screen.getByRole('spinbutton')).toBeInTheDocument();
@@ -707,7 +707,7 @@ describe('NumberInput', () => {
label="Qty"
value={0}
onChange={() => {}}
- startIcon={<HashtagIcon />}
+ startIcon={<TestIcon />}
/>,
);
diff --git a/packages/core/src/TextArea/TextArea.test.tsx b/packages/core/src/TextArea/TextArea.test.tsx
index 48b74783df..864f3d5418 100644
--- a/packages/core/src/TextArea/TextArea.test.tsx
+++ b/packages/core/src/TextArea/TextArea.test.tsx
@@ -13,7 +13,7 @@ import {useState} from 'react';
import {describe, it, expect, vi, beforeEach} from 'vitest';
import {render, screen, fireEvent, waitFor} from '@testing-library/react';
import userEvent from '@testing-library/user-event';
-import {MagnifyingGlassIcon} from '@heroicons/react/24/outline';
+import {TestIcon} from '../__tests__/TestIcon';
import {TextArea} from './TextArea';
// Mock showPopover/hidePopover since jsdom does not implement them. Used by the
@@ -193,7 +193,7 @@ describe('TextArea', () => {
label="Description"
value=""
onChange={() => {}}
- startIcon={MagnifyingGlassIcon}
+ startIcon={TestIcon}
/>,
);
expect(screen.getByRole('textbox')).toBeInTheDocument();
@@ -577,7 +577,7 @@ describe('TextArea', () => {
label="Notes"
value=""
onChange={() => {}}
- startIcon={<MagnifyingGlassIcon />}
+ startIcon={<TestIcon />}
/>,
);
diff --git a/packages/core/src/TextInput/TextInput.test.tsx b/packages/core/src/TextInput/TextInput.test.tsx
index 9e50cd1ee7..331e282d3c 100644
--- a/packages/core/src/TextInput/TextInput.test.tsx
+++ b/packages/core/src/TextInput/TextInput.test.tsx
@@ -12,7 +12,7 @@
import {describe, it, expect, vi, beforeEach} from 'vitest';
import {render, screen, fireEvent, waitFor} from '@testing-library/react';
import userEvent from '@testing-library/user-event';
-import {MagnifyingGlassIcon} from '@heroicons/react/24/outline';
+import {TestIcon} from '../__tests__/TestIcon';
import {TextInput} from './TextInput';
// Mock showPopover/hidePopover since jsdom does not implement them. Used by the
@@ -163,7 +163,7 @@ describe('TextInput', () => {
label="Search"
value=""
onChange={() => {}}
- startIcon={MagnifyingGlassIcon}
+ startIcon={TestIcon}
/>,
);
expect(screen.getByRole('textbox')).toBeInTheDocument();
@@ -482,7 +482,7 @@ describe('TextInput', () => {
label="Search"
value=""
onChange={() => {}}
- startIcon={<MagnifyingGlassIcon />}
+ startIcon={<TestIcon />}
/>,
);
diff --git a/packages/core/src/__tests__/TestIcon.tsx b/packages/core/src/__tests__/TestIcon.tsx
new file mode 100644
index 0000000000..5eef2379f7
--- /dev/null
+++ b/packages/core/src/__tests__/TestIcon.tsx
@@ -0,0 +1,26 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+/**
+ * @file TestIcon.tsx
+ * @input Standard SVG props
+ * @output A minimal SVG React component for tests
+ * @position Test fixture; a stand-in external SVG icon for Icon component-mode tests
+ *
+ * A trivial SVG component used by tests that need to pass a custom SVG icon to
+ * `Icon` (component mode) or component `*Icon` props. It forwards all standard
+ * SVG props and its ref so tests exercising prop/ref forwarding behave the same
+ * as a real third-party icon component.
+ */
+
+import React, {type SVGProps} from 'react';
+
+export function TestIcon({
+ ref,
+ ...props
+}: SVGProps<SVGSVGElement> & {ref?: React.Ref<SVGSVGElement>}) {
+ return (
+ <svg ref={ref} viewBox="0 0 24 24" {...props}>
+ <path d="M4 4h16v16H4z" />
+ </svg>
+ );
+}