Components / UI components / Rich Content
Rich contentExperimental alpha

MarkdownResponse

Streaming GFM with headings, lists, tables, code, links and footnotes.

MarkdownResponse preview

Loading example…

Interactions use local sample data.

Usage and props

Display a Markdown response as text arrives. RichMarkdownResponse also renders supported math and Mermaid fences. Pass the Markdown text from your response. Optional /markdown entry; raw HTML stays text and remote Markdown images never auto-load.

textstring
The response so far. Update it as new text arrives.
stateMessageData['state']
The response state from your application, including streaming or complete.
headingLevel1 | 2 | 3 | 4 | 5 | 6 (optional)
Heading level for a Markdown # heading. Defaults to 3; deeper headings stop at 6.
renderCodeBlock(props: MarkdownCodeBlockProps) => ReactNode (optional)
Render fenced code with your own component. Define this callback in your application.
How state and callbacks work

These are the main props for the example. The package's TypeScript declarations include the full API.

Customize and use with a keyboard