直接跳到内容

Markdown / MarkdownViewer Markdown 渲染

Markdown 组件将 Markdown 文本渲染为富文本终端内容;MarkdownViewer 在此基础上增加了可折叠的目录侧边栏,适合展示较长文档。两者均支持 content slot 直接内联写入 Markdown 文本。

底层:Textual Markdown · Textual MarkdownViewer

基本用法

Props

Markdown

属性类型默认值说明
markdownstr""要渲染的 Markdown 文本内容

MarkdownViewer

属性类型默认值说明
markdownstr""要渲染的 Markdown 文本内容
show_table_of_contentsboolTrue是否在左侧显示目录(TOC)面板

v-model

  • Markdownv-model 默认绑定属性 markdown,可动态更新渲染内容
  • MarkdownViewerv-model 默认绑定属性 markdown

Content Slot

除了通过 markdown prop 传入内容,也可以直接在组件标签内部书写 Markdown 文本(content slot):

事件

事件说明
@markdown_link_clicked点击 Markdown 内链接时触发(Markdown.LinkClicked),event.href 为链接地址

通用属性

所有 Textual-vuepy 组件均支持以下属性:

属性类型说明
idstr组件 CSS ID
stylestrTCSS 内联样式
classstrTCSS 类名(空格分隔)
border_titlestr边框标题
border_subtitlestr边框副标题
Markdown / MarkdownViewer Markdown 渲染已经加载完毕