hashbrown

MagicTextRendererProps

Props for the MagicTextRenderer component.

API

caret
MagicTextCaret

Caret rendering behavior for streaming output.

  • false/undefined: no caret - true: render the default caret - ReactNode: render a custom caret node - function: render a custom caret node from parser state
children
string

Full markdown source that grows over time.

className
string

Optional class applied to the root element.

isComplete
boolean

When true, finalizes the parser state after applying the latest text.

nodeRenderers
MagicTextNodeRenderers

Optional custom renderers keyed by Magic Text node type.

onCitationClick
(event: MouseEvent<HTMLAnchorElement>, citation: MagicTextCitationRenderData, node: MagicTextAstNode) => void

Called when a citation reference is clicked.

onLinkClick
(event: MouseEvent<HTMLAnchorElement>, url: string, node: MagicTextAstNode) => void

Called when a link or autolink is clicked.

options
Partial<MagicTextParserOptions>

Optional parser option overrides.