Skip to content

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

TypeScript

fix(markdown): honor components.image override for block images (#4100)

Alexander Blomaa937abd02b5
diff --git a/.changeset/scout-md-block-image-override.md b/.changeset/scout-md-block-image-override.md
new file mode 100644
index 0000000000..429135a2d5
--- /dev/null
+++ b/.changeset/scout-md-block-image-override.md
@@ -0,0 +1,6 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] Markdown honors the `components.image` override for standalone (block) images, matching the inline image path. A standalone `![alt](src)` line parses as a block image, whose render path previously hardcoded a bare `<img>` and ignored a supplied `components.image`; it now uses the override just like an inline image does.
+@lexs
diff --git a/packages/core/src/Markdown/Markdown.test.tsx b/packages/core/src/Markdown/Markdown.test.tsx
index 242c4a398a..1720be73bf 100644
--- a/packages/core/src/Markdown/Markdown.test.tsx
+++ b/packages/core/src/Markdown/Markdown.test.tsx
@@ -236,6 +236,27 @@ describe('Markdown', () => {
expect(img!.getAttribute('src')).toBe('image.png');
});
+ it('uses the components.image override for a standalone (block) image', () => {
+ // A standalone image line parses as a block image; its render path must
+ // honor components.image just like the inline image path does.
+ render(
+ <Markdown
+ components={{
+ image: ({src, alt}) => (
+ <span data-testid="custom-image" data-src={src}>
+ {alt}
+ </span>
+ ),
+ }}>
+ {'![alt text](image.png)'}
+ </Markdown>,
+ );
+ expect(document.querySelector('img')).not.toBeInTheDocument();
+ const custom = screen.getByTestId('custom-image');
+ expect(custom).toHaveTextContent('alt text');
+ expect(custom.getAttribute('data-src')).toBe('image.png');
+ });
+
it('shifts heading levels with headingLevelStart', () => {
render(<Markdown headingLevelStart={3}>{'# Heading 1'}</Markdown>);
expect(screen.getByText('Heading 1').tagName).toBe('H3');
diff --git a/packages/core/src/Markdown/Markdown.tsx b/packages/core/src/Markdown/Markdown.tsx
index 4d202fff2c..0854bc4e2b 100644
--- a/packages/core/src/Markdown/Markdown.tsx
+++ b/packages/core/src/Markdown/Markdown.tsx
@@ -1523,6 +1523,10 @@ function renderBlock(
</div>
);
}
+ const ImageComp = components?.image;
+ if (ImageComp) {
+ return <ImageComp key={index} src={safeSrc} alt={node.alt} />;
+ }
return (
<div
key={index}