#markdown
Markdown 渲染组件,用于渲染 Markdown 内容,支持打字机动画、文本选择和文本标注。
#扫码预览
#Props
| 属性名 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| animationType | "none" | "typewriter" | 'none' | 否 | 动画类型 |
| animationVelocity | number | 1 | 否 | 动画速度。打字机模式下表示每秒输出字符数 |
| className | string | - | 否 | 组件类名 |
| content | string | - | 是 | Markdown 源内容 |
| contentComplete | boolean | true | 否 | 打字机动画完成后是否隐藏光标并触发绘制完成事件 |
| contentId | string | - | 否 | 内容标识,会在事件和 UI 方法中回传 |
| contentRange | number[] | [0, int32_max] | 否 | 需要解析的内容区间 |
| enableGif | boolean | false | 否 | 是否启用 GIF 动画 |
| id | string | - | 否 | 元素的唯一标识 |
| initialAnimationStep | number | 0 | 否 | 动画起始步数 |
| key | string | number | null | - | 否 | React key 属性 |
| markdownEffect | MarkdownEffect | {} | 否 | 额外 Markdown 效果配置 |
| markdownStyle | MarkdownStyle | {} | 否 | Markdown 内部元素样式表。它不是普通的 CSS style:颜色使用不带 # 的十六进制字符串(如 '151515'),尺寸使用 number(如 fontSize: 15、lineHeight: 22),不要传 var(--color)、'#151515' 或 '15px'。 |
| onAnimationStep | (event: MarkdownEvent<"bindanimationStep", MarkdownAnimationStepEvent>) => void | - | 否 | 动画每步结束时触发 |
| onDrawEnd | (event: MarkdownEvent<"binddrawEnd">) => void | - | 否 | 绘制完成时触发 |
| onDrawStart | (event: MarkdownEvent<"binddrawStart">) => void | - | 否 | 开始绘制时触发 |
| onImageTap | (event: MarkdownEvent<"bindimageTap", MarkdownImageTapEvent>) => void | - | 否 | 点击图片时触发 |
| onLink | (event: MarkdownEvent<"bindlink", MarkdownLinkEvent>) => void | - | 否 | 点击链接时触发 |
| onOverflow | (event: MarkdownEvent<"bindoverflow", MarkdownOverflowEvent>) => void | - | 否 | 文本溢出时触发 |
| onParseEnd | (event: MarkdownEvent<"bindparseEnd", MarkdownParseEndEvent>) => void | - | 否 | 解析完成时触发 |
| onSelectionChange | (event: MarkdownEvent<"bindselectionchange", MarkdownSelectionChangeEvent>) => void | - | 否 | 文本选择变化时触发 |
| onTextClick | (event: MarkdownEvent<"bindtextClick", MarkdownTextClickEvent>) => void | - | 否 | 点击 textMarkAttachments 中的可点击标注时触发 |
| ref | Ref<MarkdownRef> | - | 否 | 用于获取组件实例的 ref |
| style | CSSProperties | - | 否 | 组件样式 |
| textMarkAttachments | MarkdownMarkAttachment[] | [] | 否 | 文本高亮、下划线等标注配置 |
| textMaxline | number | - | 否 | 最大文本行数,表格行也会计为一行 |
| textSelection | boolean | false | 否 | 是否支持文本选择 |
| typewriterDynamicHeight | boolean | false | 否 | 打字机模式下高度是否跟随已输出内容变化 |
| typewriterHeightTransitionDuration | number | 0 | 否 | 打字机动画扩展高度时的过渡时长 |
#Ref 方法
| 方法名 | 类型 | 说明 |
|---|---|---|
| getContent | (options?: MarkdownContentRangeOptions) => Promise<MarkdownContentResult> | 获取指定区间的已解析内容 |
| getImages | () => Promise<MarkdownImagesResult> | 获取 Markdown 中的所有图片地址 |
| getParseResult | (options: MarkdownParseResultOptions) => Promise<MarkdownParseResult> | 获取指定标签对应的源码区间 |
| getSelectedText | () => Promise<MarkdownSelectedTextResult> | 获取当前选中的文本 |
| getTextBoundingRect | (options?: MarkdownTextBoundingRectOptions) => Promise<MarkdownTextBoundingRectResult> | 获取指定文本区间的布局包围盒 |
| pauseAnimation | () => Promise<MarkdownAnimationStepResult> | 暂停打字机动画 |
| resumeAnimation | (options?: MarkdownResumeAnimationOptions) => Promise<void> | 继续打字机动画 |
| setTextSelection | (options: MarkdownTextSelectionOptions) => Promise<MarkdownTextSelectionResult> | 通过坐标设置文本选区 |