> For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt.

# markdown

Markdown 渲染组件，用于渲染 Markdown 内容，支持打字机动画、文本选择和文本标注。

<iframe src="https://developer.doubao.com/docs-preview/component-simulator/?caseId=markdown"
  title="组件示例 markdown"
  width="100%"
  height="700"
  loading="lazy"
  style="width:100%;height:700px;border:0;border-radius:16px;overflow:hidden;"
></iframe>

## 扫码预览

![扫码预览 markdown](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fcomponent%252Fmarkdown%252Findex)

## Props

<table>
<thead>
<tr><th width="140">属性名</th><th width="240">类型</th><th width="120">默认值</th><th width="80">必填</th><th width="360">说明</th></tr>
</thead>
<tbody>
<tr><td>animationType</td><td><code>&quot;none&quot; | &quot;typewriter&quot;</code></td><td>'none'</td><td>否</td><td>动画类型</td></tr>
<tr><td>animationVelocity</td><td><code>number</code></td><td>1</td><td>否</td><td>动画速度。打字机模式下表示每秒输出字符数</td></tr>
<tr><td>className</td><td><code>string</code></td><td>-</td><td>否</td><td>组件类名</td></tr>
<tr><td>content</td><td><code>string</code></td><td>-</td><td>是</td><td>Markdown 源内容</td></tr>
<tr><td>contentComplete</td><td><code>boolean</code></td><td>true</td><td>否</td><td>打字机动画完成后是否隐藏光标并触发绘制完成事件</td></tr>
<tr><td>contentId</td><td><code>string</code></td><td>-</td><td>否</td><td>内容标识，会在事件和 UI 方法中回传</td></tr>
<tr><td>contentRange</td><td><code>number[]</code></td><td>[0, int32_max]</td><td>否</td><td>需要解析的内容区间</td></tr>
<tr><td>enableGif</td><td><code>boolean</code></td><td>false</td><td>否</td><td>是否启用 GIF 动画</td></tr>
<tr><td>id</td><td><code>string</code></td><td>-</td><td>否</td><td>元素的唯一标识</td></tr>
<tr><td>initialAnimationStep</td><td><code>number</code></td><td>0</td><td>否</td><td>动画起始步数</td></tr>
<tr><td>key</td><td><code>string | number | null</code></td><td>-</td><td>否</td><td>React key 属性</td></tr>
<tr><td>markdownEffect</td><td><code>MarkdownEffect</code></td><td>{}</td><td>否</td><td>额外 Markdown 效果配置</td></tr>
<tr><td>markdownStyle</td><td><code>MarkdownStyle</code></td><td>{}</td><td>否</td><td>Markdown 内部元素样式表。它不是普通的 CSS style：颜色使用不带 <code>#</code> 的十六进制字符串<br>（如 <code>'151515'</code>），尺寸使用 number（如 <code>fontSize: 15</code>、<code>lineHeight: 22</code>），<br>不要传 <code>var(--color)</code>、<code>'#151515'</code> 或 <code>'15px'</code>。</td></tr>
<tr><td>onAnimationStep</td><td><code>(event: MarkdownEvent&lt;&quot;bindanimationStep&quot;, MarkdownAnimationStepEvent&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>动画每步结束时触发</td></tr>
<tr><td>onDrawEnd</td><td><code>(event: MarkdownEvent&lt;&quot;binddrawEnd&quot;&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>绘制完成时触发</td></tr>
<tr><td>onDrawStart</td><td><code>(event: MarkdownEvent&lt;&quot;binddrawStart&quot;&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>开始绘制时触发</td></tr>
<tr><td>onImageTap</td><td><code>(event: MarkdownEvent&lt;&quot;bindimageTap&quot;, MarkdownImageTapEvent&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>点击图片时触发</td></tr>
<tr><td>onLink</td><td><code>(event: MarkdownEvent&lt;&quot;bindlink&quot;, MarkdownLinkEvent&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>点击链接时触发</td></tr>
<tr><td>onOverflow</td><td><code>(event: MarkdownEvent&lt;&quot;bindoverflow&quot;, MarkdownOverflowEvent&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>文本溢出时触发</td></tr>
<tr><td>onParseEnd</td><td><code>(event: MarkdownEvent&lt;&quot;bindparseEnd&quot;, MarkdownParseEndEvent&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>解析完成时触发</td></tr>
<tr><td>onSelectionChange</td><td><code>(event: MarkdownEvent&lt;&quot;bindselectionchange&quot;, MarkdownSelectionChangeEvent&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>文本选择变化时触发</td></tr>
<tr><td>onTextClick</td><td><code>(event: MarkdownEvent&lt;&quot;bindtextClick&quot;, MarkdownTextClickEvent&gt;) =&gt; void</code></td><td>-</td><td>否</td><td>点击 textMarkAttachments 中的可点击标注时触发</td></tr>
<tr><td>ref</td><td><code>Ref&lt;MarkdownRef&gt;</code></td><td>-</td><td>否</td><td>用于获取组件实例的 ref</td></tr>
<tr><td>style</td><td><code>CSSProperties</code></td><td>-</td><td>否</td><td>组件样式</td></tr>
<tr><td>textMarkAttachments</td><td><code>MarkdownMarkAttachment[]</code></td><td>[]</td><td>否</td><td>文本高亮、下划线等标注配置</td></tr>
<tr><td>textMaxline</td><td><code>number</code></td><td>-</td><td>否</td><td>最大文本行数，表格行也会计为一行</td></tr>
<tr><td>textSelection</td><td><code>boolean</code></td><td>false</td><td>否</td><td>是否支持文本选择</td></tr>
<tr><td>typewriterDynamicHeight</td><td><code>boolean</code></td><td>false</td><td>否</td><td>打字机模式下高度是否跟随已输出内容变化</td></tr>
<tr><td>typewriterHeightTransitionDuration</td><td><code>number</code></td><td>0</td><td>否</td><td>打字机动画扩展高度时的过渡时长</td></tr>
</tbody>
</table>

## Ref 方法

<table>
<thead>
<tr><th width="180">方法名</th><th width="260">类型</th><th width="360">说明</th></tr>
</thead>
<tbody>
<tr><td>getContent</td><td><code>(options?: MarkdownContentRangeOptions) =&gt; Promise&lt;MarkdownContentResult&gt;</code></td><td>获取指定区间的已解析内容</td></tr>
<tr><td>getImages</td><td><code>() =&gt; Promise&lt;MarkdownImagesResult&gt;</code></td><td>获取 Markdown 中的所有图片地址</td></tr>
<tr><td>getParseResult</td><td><code>(options: MarkdownParseResultOptions) =&gt; Promise&lt;MarkdownParseResult&gt;</code></td><td>获取指定标签对应的源码区间</td></tr>
<tr><td>getSelectedText</td><td><code>() =&gt; Promise&lt;MarkdownSelectedTextResult&gt;</code></td><td>获取当前选中的文本</td></tr>
<tr><td>getTextBoundingRect</td><td><code>(options?: MarkdownTextBoundingRectOptions) =&gt; Promise&lt;MarkdownTextBoundingRectResult&gt;</code></td><td>获取指定文本区间的布局包围盒</td></tr>
<tr><td>pauseAnimation</td><td><code>() =&gt; Promise&lt;MarkdownAnimationStepResult&gt;</code></td><td>暂停打字机动画</td></tr>
<tr><td>resumeAnimation</td><td><code>(options?: MarkdownResumeAnimationOptions) =&gt; Promise&lt;void&gt;</code></td><td>继续打字机动画</td></tr>
<tr><td>setTextSelection</td><td><code>(options: MarkdownTextSelectionOptions) =&gt; Promise&lt;MarkdownTextSelectionResult&gt;</code></td><td>通过坐标设置文本选区</td></tr>
</tbody>
</table>
