logoAnt Design X

设计研发组件X MarkdownX SDKX CardX Skill演示国内镜像
  • 介绍
  • 代码示例
    2.0.0
  • 在线体验
  • 主题
  • 流式渲染
  • 组件
    • 总览
    • 聊天增强
    • 数据展示
    • 富文本增强
  • 插件集
    • 总览
    • 公式
    • 自定义插件

代码示例

使用import { XMarkdown } from "@ant-design/x-markdown";
源码x-markdown/src/x-markdown
文档
编辑此页
版本自 2.0.0 起支持

何时使用

用于快速接入 LLM 的 Markdown 输出渲染。

代码演示

API

属性说明类型默认值
content需要渲染的 Markdown 内容string-
childrenMarkdown 内容(与 content 二选一)string-
components将 HTML 节点映射为自定义 React 组件Record<string, React.ComponentType<ComponentProps> | keyof JSX.IntrinsicElements>-
streaming流式渲染行为配置StreamingOption-
configMarked 解析配置,后应用且可能覆盖内置 rendererMarkedExtension{ gfm: true }
rootClassName根元素的额外 CSS 类名string-
className根容器的额外 CSS 类名string-
paragraphTag段落使用的 HTML 标签(避免自定义组件含块级元素时的校验问题)keyof JSX.IntrinsicElements'p'
style根容器的内联样式CSSProperties-
prefixCls组件节点 CSS 类名前缀string-
openLinksInNewTab是否为所有链接添加 target="_blank" 并在新标签页打开booleanfalse
dompurifyConfigHTML 净化与 XSS 防护的 DOMPurify 配置DOMPurify.Config-
protectCustomTagNewlines是否保留自定义标签内部的换行booleanfalse
escapeRawHtml是否将 Markdown 中的原始 HTML 转义为纯文本展示(不解析为真实 HTML),用于防 XSS 同时保留内容booleanfalse
debug是否开启调试模式(显示性能监控浮层)booleanfalse

StreamingOption

字段说明类型默认值
hasNextChunk是否还有后续内容块。为 false 时会刷新缓存并完成渲染booleanfalse
enableAnimation是否为块级元素启用文字淡入动画booleanfalse
animationConfig动画配置(如淡入时长、缓动函数)AnimationConfig-
tail是否启用尾部指示器boolean | TailConfigfalse
incompleteMarkdownComponentMap将未闭合 Markdown 片段映射到自定义 loading 组件Partial<Record<'link' | 'image' | 'html' | 'emphasis' | 'list' | 'table' | 'inline-code', string>>{ link: 'incomplete-link', image: 'incomplete-image' }

TailConfig

属性说明类型默认值
content尾部显示的内容string'▋'
component自定义尾部组件,优先级高于 contentReact.ComponentType<{ content?: string }>-

AnimationConfig

属性说明类型默认值
fadeDuration动画时长(毫秒)number200
easing缓动函数string'ease-in-out'
基础渲染
CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
流式渲染

语法补全和缓存、动画以及尾缀

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
组件扩展

将 code 块映射为 CodeHighlighter

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
插件扩展

扩展 Markdown 语法

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
安全与链接

原始 HTML 转义与新标签链接

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code