UNPKG

vditor

Version:

♏ 易于使用的 Markdown 编辑器,为适配不同的应用场景而生

52 lines (51 loc) 2.97 kB
import * as adapterRender from "./ts/markdown/adapterRender"; declare class Vditor { /** 点击图片放大 */ static adapterRender: typeof adapterRender; /** 点击图片放大 */ static previewImage: (oldImgElement: HTMLImageElement, lang?: keyof II18n, theme?: string) => void; /** 为 element 中的代码块添加复制按钮 */ static codeRender: (element: HTMLElement, option?: IHljs) => void; /** 对 graphviz 进行渲染 */ static graphvizRender: (element: HTMLElement, cdn?: string) => void; /** 为 element 中的代码块进行高亮渲染 */ static highlightRender: (hljsOption?: IHljs, element?: HTMLElement | Document, cdn?: string) => void; /** 对数学公式进行渲染 */ static mathRender: (element?: HTMLElement | Document, options?: { cdn?: string; math?: IMath; }) => void; /** 流程图/时序图/甘特图渲染 */ static mermaidRender: (element: HTMLElement | Document, cdn: string, theme: string) => void; /** 化学物质结构渲染 */ static SMILESRender: (element: HTMLElement | Document, cdn: string, theme: string) => void; /** 支持 markdown 的思维导图 */ static markmapRender: (element?: HTMLElement | Document, cdn?: string) => void; /** flowchart.js 渲染 */ static flowchartRender: (element: HTMLElement, cdn?: string) => void; /** 图表渲染 */ static chartRender: (element: HTMLElement | Document, cdn: string, theme: string) => void; /** 五线谱渲染 */ static abcRender: (element?: HTMLElement | Document, cdn?: string) => void; /** 脑图渲染 */ static mindmapRender: (element: HTMLElement | Document, cdn: string, theme: string) => void; /** plantuml渲染 */ static plantumlRender: (element?: HTMLElement | Document, cdn?: string) => void; /** 大纲渲染 */ static outlineRender: (contentElement: HTMLElement, targetElement: Element, vditor?: IVditor) => string; /** 为[特定链接](https://github.com/Vanessa219/vditor/issues/7)分别渲染为视频、音频、嵌入的 iframe */ static mediaRender: (element: HTMLElement) => void; /** 对选中的文字进行阅读 */ static speechRender: (element: HTMLElement, lang?: keyof II18n) => void; /** 对图片进行懒加载 */ static lazyLoadImageRender: (element?: HTMLElement | Document) => boolean; /** Markdown 文本转换为 HTML,该方法需使用[异步编程](https://ld246.com/article/1546828434083?r=Vaness) */ static md2html: (mdText: string, options?: IPreviewOptions) => Promise<string>; /** 页面 Markdown 文章渲染 */ static preview: (previewElement: HTMLDivElement, markdown: string, options?: IPreviewOptions) => Promise<void>; /** 设置代码主题 */ static setCodeTheme: (codeTheme: string, cdn?: string) => void; /** 设置内容主题 */ static setContentTheme: (contentTheme: string, path: string) => void; } export default Vditor;