Skip to main content

XMarkdown

Renders Markdown content with streaming animation support, optimized for AI responses.

VEF wrapper around @ant-design/x-markdown. Extends the base component with VEF theme integration.

Basic Usage

import { XMarkdown } from '@vef-framework-react/components';

export default function Demo() {
return (
<XMarkdown>
{`# Hello

This is **markdown** content with \`inline code\`.

\`\`\`typescript
const x = 1;
\`\`\`
`}
</XMarkdown>
);
}

Streaming

import { XMarkdown, useXMarkdownStreaming } from '@vef-framework-react/components';

export default function StreamingDemo() {
const { content, isStreaming } = useXMarkdownStreaming(streamSource);

return <XMarkdown>{content}</XMarkdown>;
}

API

XMarkdown extends @ant-design/x-markdown props:

PropTypeDefaultDescription
childrenstringrequiredMarkdown string
componentsComponentsCustom renderers for markdown elements
configMarkdownConfigMarkdown parser config
classNamestringCSS class

Additional Exports

ExportDescription
useXMarkdownStreamingHook for streaming markdown content
XMarkdownAnimationTextAnimated text component