设置内容,setValue(content:string, keepCursor = false)有同样的功能
keepCursor = true 更新内容的时候保持光标位置
插入内容
isSelect=true 选中刚插入的内容
anchor=false 在光标处插入内容,anchor=[1,3] 在第2行第4个字符处插入内容
重置工具栏
type 修改工具栏的类型 {'toolbar'|'toolbarRight'|'sidebar'|'bubble'|'float'|'toc'}
toolbar 工具栏配置
滚动到对应id的元素位置
id 可以为带#号hash,也可以是id值
behavior: smooth(默认) 平滑滚动;instant 立即滚动;auto 跟随浏览器默认行为
滚动到对应位置
scrollTop 滚动距离
behavior: auto(默认) 跟随浏览器默认行为;smooth 平滑滚动;instant 立即滚动
获取文档顶部 Front Matter(--- 包裹的元数据块)
支持两种格式:
1. JSON 格式:---\n{"title":"cherry"}\n---
2. key:value 多行格式(推荐):---\ntitle: cherry\nauthor: tencent\n---
返回值:解析后的对象,无 front-matter 或解析失败时返回 {}
设置文档顶部 Front Matter
data:元数据对象或 front-matter 内容字符串
k: v 多行格式,否则回退到 JSON 格式{} 或空字符串 '':移除已存在的 front-matterkeepCursor:覆盖内容后是否保持光标位置,默认 falsemerge:当 data 为对象时是否与现有 front-matter 合并,默认 false禁用/启用编辑器
isDisable=true 编辑器切换为只读,并在编辑器上覆盖一个蒙层,阻止一切交互
isDisable=false 恢复编辑器正常状态
tips 禁用时显示在蒙层上的提示文案
监听事件
eventName 事件名,见下表
callback 回调函数
支持的事件名:
| eventName | 触发时机 | callback 入参 |
|---|---|---|
| afterInit | 编辑器初始化完成 | (markdownText, html) |
| afterChange | 编辑器内容改变并完成渲染 | (markdownText, html) |
| afterAsyncRender | 编辑器完成所有异步渲染 | (markdownText, html) |
| focus | 编辑器获得焦点 | ({e, cherry}) |
| blur | 编辑器失去焦点 | ({e, cherry}) |
| selectionChange | 编辑器选区变化 | ({selections, lastSelections, info}) |
| afterChangeLocale | 变更语言 | (locale) |
| changeMainTheme | 变更主题 | (theme) |
| changeCodeBlockTheme | 变更代码块主题 | (theme) |
| previewerClose | 预览区关闭 | - |
| previewerOpen | 预览区打开 | - |
| editorClose | 编辑区关闭 | - |
| editorOpen | 编辑区打开 | - |
| toolbarHide | 工具栏隐藏 | - |
| toolbarShow | 工具栏显示 | - |
将markdown字符串渲染成Html
returnType='string':返回html字符串
returnType='object':返回HTMLCollection
注:要调用 toolbarHandlers 的API,需要先在cherry.config.toolbars的“toolbar|toolbarRight|sidebar|bubble|float”中的其中一项里配置上对应的工具栏
向cherry编辑器中插入字体颜色或字体背景色语法
| param | 效果 |
|---|---|
| 'color: #c2255c' | 字体颜色 |
| 'background-color: #c2255c' | 字体背景颜色 |
向cherry编辑器中插入对齐方式或信息面板语法
| param | 效果 |
|---|---|
| 'left' | 左对齐 |
| 'center' | 居中对齐 |
| 'right' | 右对齐 |
| 'primary' | 首选项 |
| 'info' | 一般信息 |
| 'warning' | 警告 |
| 'danger' | 危险 |
| 'success' | 成功 |
向cherry编辑器中插入有序、无序列表或者checklist语法
| level | 效果 |
|---|---|
| '1' | ol 列表 |
| '2' | ul 列表 |
| '3' | checklist |
向cherry编辑器中插入特定语法:
| type | 效果 |
|---|---|
| 'hr' | 删除线 |
| 'br' | 强制换行 |
| 'code' | 代码块 |
| 'formula' | 行内公式 |
| 'checklist' | 检查项 |
| 'toc' | 目录 |
| 'link' | 超链接 |
| 'normal-table' | 插入3行5列的表格 |
| 'normal-table-row*col' | 如normal-table-2*4插入2行(包含表头是3行)4列的表格 |
向cherry编辑器中插入画图语法
| id | 效果 |
|---|---|
| '1' | 流程图 |
| '2' | 时序图 |
| '3' | 状态图 |
| '4' | 类图 |
| '5' | 饼图 |
| '6' | 甘特图 |